2018-06-25 10:20:36 +00:00
<!DOCTYPE html>
< html lang = "en" >
< head >
< meta charset = "utf-8" >
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" >
< meta name = "generator" content = "rustdoc" >
< meta name = "description" content = "API documentation for the Rust `store_open` fn in crate `mentat_ffi`." >
< meta name = "keywords" content = "rust, rustlang, rust-lang, store_open" >
< title > mentat_ffi::store_open - Rust< / title >
< link rel = "stylesheet" type = "text/css" href = "../normalize.css" >
< link rel = "stylesheet" type = "text/css" href = "../rustdoc.css"
id="mainThemeStyle">
< link rel = "stylesheet" type = "text/css" href = "../dark.css" >
< link rel = "stylesheet" type = "text/css" href = "../light.css" id = "themeStyle" >
< script src = "../storage.js" > < / script >
< / head >
< body class = "rustdoc fn" >
<!-- [if lte IE 8]>
< div class = "warning" >
This old browser is unsupported and will most likely display funky
things.
< / div >
<![endif]-->
< nav class = "sidebar" >
< div class = "sidebar-menu" > ☰ < / div >
< div class = "sidebar-elems" > < p class = 'location' > < a href = 'index.html' > mentat_ffi< / a > < / p > < script > window . sidebarCurrent = { name : 'store_open' , ty : 'fn' , relpath : '' } ; < / script > < script defer src = "sidebar-items.js" > < / script > < / div >
< / nav >
< div class = "theme-picker" >
< button id = "theme-picker" aria-label = "Pick another theme!" >
< img src = "../brush.svg" width = "18" alt = "Pick another theme!" >
< / button >
< div id = "theme-choices" > < / div >
< / div >
< script src = "../theme.js" > < / script >
< nav class = "sub" >
< form class = "search-form js-only" >
< div class = "search-container" >
< input class = "search-input" name = "search"
autocomplete="off"
placeholder="Click or press ‘ ’ ‘ ’
type="search">
< / div >
< / form >
< / nav >
< section id = 'main' class = "content" > < h1 class = 'fqn' > < span class = 'in-band' > Function < a href = 'index.html' > mentat_ffi< / a > ::< wbr > < a class = "fn" href = '' > store_open< / a > < / span > < span class = 'out-of-band' > < span id = 'render-detail' >
< a id = "toggle-all-docs" href = "javascript:void(0)" title = "collapse all docs" >
[< span class = 'inner' > − < / span > ]
< / a >
2018-06-29 17:28:44 +00:00
< / span > < a class = 'srclink' href = '../src/mentat_ffi/lib.rs.html#212-217' title = 'goto source code' > [src]< / a > < / span > < / h1 > < pre class = 'rust fn' > < div class = "docblock attributes" > #[no_mangle]
2018-06-25 10:20:36 +00:00
< / div > pub extern " C" fn store_open(uri: < a class = "primitive" href = "https://doc.rust-lang.org/nightly/std/primitive.pointer.html" > *const < / a > < a class = "type" href = "https://doc.rust-lang.org/nightly/std/os/raw/type.c_char.html" title = "type std::os::raw::c_char" > c_char< / a > ) -> < a class = "primitive" href = "https://doc.rust-lang.org/nightly/std/primitive.pointer.html" > *mut < / a > < a class = "struct" href = "../mentat_ffi/struct.Store.html" title = "struct mentat_ffi::Store" > Store< / a > < / pre > < div class = 'docblock' > < p > A store cannot be opened twice to the same location.
Once created, the reference to the store is held by the caller and not Rust,
2018-06-29 17:28:44 +00:00
therefore the caller is responsible for calling < code > store_destroy< / code > to release the memory
2018-06-25 10:20:36 +00:00
used by the < a href = "mentat::Store" > Store< / a > in order to avoid a memory leak.< / p >
< h1 id = "safety" class = "section-header" > < a href = "#safety" > Safety< / a > < / h1 >
< p > Callers are responsible for managing the memory for the return value.
A destructor < code > store_destroy< / code > is provided for releasing the memory for this
pointer type.< / p >
< / div > < / section >
< section id = 'search' class = "content hidden" > < / section >
< section class = "footer" > < / section >
< aside id = "help" class = "hidden" >
< div >
< h1 class = "hidden" > Help< / h1 >
< div class = "shortcuts" >
< h2 > Keyboard Shortcuts< / h2 >
< dl >
< dt > < kbd > ?< / kbd > < / dt >
< dd > Show this help dialog< / dd >
< dt > < kbd > S< / kbd > < / dt >
< dd > Focus the search field< / dd >
< dt > < kbd > ↑< / kbd > < / dt >
< dd > Move up in search results< / dd >
< dt > < kbd > ↓< / kbd > < / dt >
< dd > Move down in search results< / dd >
< dt > < kbd > ↹< / kbd > < / dt >
< dd > Switch tab< / dd >
< dt > < kbd > ⏎ < / kbd > < / dt >
< dd > Go to active search result< / dd >
< dt > < kbd > +< / kbd > < / dt >
< dd > Expand all sections< / dd >
< dt > < kbd > -< / kbd > < / dt >
< dd > Collapse all sections< / dd >
< / dl >
< / div >
< div class = "infos" >
< h2 > Search Tricks< / h2 >
< p >
Prefix searches with a type followed by a colon (e.g.
< code > fn:< / code > ) to restrict the search to a given type.
< / p >
< p >
Accepted types are: < code > fn< / code > , < code > mod< / code > ,
< code > struct< / code > , < code > enum< / code > ,
< code > trait< / code > , < code > type< / code > , < code > macro< / code > ,
and < code > const< / code > .
< / p >
< p >
Search functions by type signature (e.g.
< code > vec -> usize< / code > or < code > * -> vec< / code > )
< / p >
< / div >
< / div >
< / aside >
< script >
window.rootPath = "../";
window.currentCrate = "mentat_ffi";
< / script >
< script src = "../main.js" > < / script >
< script defer src = "../search-index.js" > < / script >
< / body >
< / html >
