2018-06-21 14:44:35 +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 `ExternResult` struct in crate `mentat_ffi`." >
< meta name = "keywords" content = "rust, rustlang, rust-lang, ExternResult" >
< title > mentat_ffi::ExternResult - 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 struct" >
<!-- [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 >
< p class = 'location' > Struct ExternResult< / p > < div class = "sidebar-elems" > < div class = "block items" > < a class = "sidebar-title" href = "#fields" > Fields< / a > < div class = "sidebar-links" > < a href = "#structfield.ok" > ok< / a > < a href = "#structfield.err" > err< / a > < / div > < a class = "sidebar-title" href = "#implementations" > Trait Implementations< / a > < div class = "sidebar-links" > < a href = "#impl-Debug" > Debug< / a > < a href = "#impl-From%3CResult%3CT%2C%20E%3E%3E" > From< Result< T, E> > < / a > < / div > < a class = "sidebar-title" href = "#synthetic-implementations" > Auto Trait Implementations< / a > < div class = "sidebar-links" > < a href = "#impl-Send" > !Send< / a > < a href = "#impl-Sync" > !Sync< / a > < / div > < / div > < p class = 'location' > < a href = 'index.html' > mentat_ffi< / a > < / p > < script > window . sidebarCurrent = { name : 'ExternResult' , ty : 'struct' , 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' > Struct < a href = 'index.html' > mentat_ffi< / a > ::< wbr > < a class = "struct" href = '' > ExternResult< / 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-22 17:25:54 +00:00
< / span > < a class = 'srclink' href = '../src/mentat_ffi/lib.rs.html#205-208' title = 'goto source code' > [src]< / a > < / span > < / h1 > < div class = "docblock type-decl" > < pre class = 'rust struct' > < div class = "docblock attributes" > #[repr(C)]
2018-06-21 14:44:35 +00:00
< / div > pub struct ExternResult {
pub ok: < a class = "primitive" href = "https://doc.rust-lang.org/nightly/std/primitive.pointer.html" > *const < / a > < a class = "enum" href = "https://doc.rust-lang.org/nightly/std/os/raw/enum.c_void.html" title = "enum std::os::raw::c_void" > c_void< / a > ,
pub err: < 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 > ,
}< / pre > < / div > < div class = 'docblock' > < p > A C representation Rust's < a href = "std::result::Result" > Result< / a > .
A value of < code > Ok< / code > results in < code > ok< / code > containing a raw pointer as a < code > c_void< / code >
and < code > err< / code > containing a null pointer.
A value of < code > Err< / code > results in < code > value< / code > containing a null pointer and < code > err< / code > containing an error message.< / p >
< p > #Safety< / p >
< p > Callers are responsible for managing the memory for the return value.
A destructor < code > destroy< / code > is provided for releasing the memory for this
pointer type.< / p >
< / div > < h2 id = 'fields' class = 'fields small-section-header' >
Fields< a href = '#fields' class = 'anchor' > < / a > < / h2 > < span id = "structfield.ok" class = "structfield small-section-header" >
< a href = "#structfield.ok" class = "anchor field" > < / a >
< span id = "ok.v" class = 'invisible' >
< code > ok: < a class = "primitive" href = "https://doc.rust-lang.org/nightly/std/primitive.pointer.html" > *const < / a > < a class = "enum" href = "https://doc.rust-lang.org/nightly/std/os/raw/enum.c_void.html" title = "enum std::os::raw::c_void" > c_void< / a > < / code >
< / span > < / span > < span id = "structfield.err" class = "structfield small-section-header" >
< a href = "#structfield.err" class = "anchor field" > < / a >
< span id = "err.v" class = 'invisible' >
< code > err: < 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 > < / code >
< / span > < / span >
< h2 id = 'implementations' class = 'small-section-header' >
Trait Implementations< a href = '#implementations' class = 'anchor' > < / a >
< / h2 >
< div id = 'implementations-list' >
2018-06-22 17:25:54 +00:00
< h3 id = 'impl-Debug' class = 'impl' > < span class = 'in-band' > < table class = 'table-display' > < tbody > < tr > < td > < code > impl < a class = "trait" href = "https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title = "trait core::fmt::Debug" > Debug< / a > for < a class = "struct" href = "../mentat_ffi/struct.ExternResult.html" title = "struct mentat_ffi::ExternResult" > ExternResult< / a > < / code > < a href = '#impl-Debug' class = 'anchor' > < / a > < / span > < / td > < td > < span class = 'out-of-band' > < div class = 'ghost' > < / div > < a class = 'srclink' href = '../src/mentat_ffi/lib.rs.html#204' title = 'goto source code' > [src]< / a > < / span > < / td > < / tr > < / tbody > < / table > < / h3 > < div class = 'impl-items' > < h4 id = 'method.fmt' class = "method" > < span id = 'fmt.v' class = 'invisible' > < table class = 'table-display' > < tbody > < tr > < td > < code > fn < a href = 'https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class = 'fnname' > fmt< / a > (& self, __arg_0: & mut < a class = "struct" href = "https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title = "struct core::fmt::Formatter" > Formatter< / a > ) -> < a class = "type" href = "https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title = "type core::fmt::Result" > Result< / a > < / code > < / span > < / td > < td > < span class = 'out-of-band' > < div class = 'ghost' > < / div > < a class = 'srclink' href = '../src/mentat_ffi/lib.rs.html#204' title = 'goto source code' > [src]< / a > < / td > < / tr > < / tbody > < / table > < / span > < / h4 > < div class = 'docblock' > < p > Formats the value using the given formatter. < a href = "https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt" > Read more< / a > < / p >
< / div > < / div > < h3 id = 'impl-From%3CResult%3CT%2C%20E%3E%3E' class = 'impl' > < span class = 'in-band' > < table class = 'table-display' > < tbody > < tr > < td > < code > impl< T, E> < a class = "trait" href = "https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title = "trait core::convert::From" > From< / a > < < a class = "enum" href = "https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title = "enum core::result::Result" > Result< / a > < T, E> > for < a class = "struct" href = "../mentat_ffi/struct.ExternResult.html" title = "struct mentat_ffi::ExternResult" > ExternResult< / a > < span class = "where fmt-newline" > where< br > E: < a class = "trait" href = "https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html" title = "trait core::fmt::Display" > Display< / a > , < / span > < / code > < a href = '#impl-From%3CResult%3CT%2C%20E%3E%3E' class = 'anchor' > < / a > < / span > < / td > < td > < span class = 'out-of-band' > < div class = 'ghost' > < / div > < a class = 'srclink' href = '../src/mentat_ffi/lib.rs.html#210-227' title = 'goto source code' > [src]< / a > < / span > < / td > < / tr > < / tbody > < / table > < / h3 > < div class = 'impl-items' > < h4 id = 'method.from' class = "method" > < span id = 'from.v' class = 'invisible' > < table class = 'table-display' > < tbody > < tr > < td > < code > fn < a href = 'https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class = 'fnname' > from< / a > (result: < a class = "enum" href = "https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title = "enum core::result::Result" > Result< / a > < T, E> ) -> Self< / code > < / span > < / td > < td > < span class = 'out-of-band' > < div class = 'ghost' > < / div > < a class = 'srclink' href = '../src/mentat_ffi/lib.rs.html#211-226' title = 'goto source code' > [src]< / a > < / td > < / tr > < / tbody > < / table > < / span > < / h4 > < div class = 'docblock' > < p > Performs the conversion.< / p >
2018-06-21 14:44:35 +00:00
< / div > < / div > < / div >
< h2 id = 'synthetic-implementations' class = 'small-section-header' >
Auto Trait Implementations< a href = '#synthetic-implementations' class = 'anchor' > < / a >
< / h2 >
< div id = 'synthetic-implementations-list' >
< h3 id = 'impl-Send' class = 'impl' > < span class = 'in-band' > < table class = 'table-display' > < tbody > < tr > < td > < code > impl !< a class = "trait" href = "https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title = "trait core::marker::Send" > Send< / a > for < a class = "struct" href = "../mentat_ffi/struct.ExternResult.html" title = "struct mentat_ffi::ExternResult" > ExternResult< / a > < / code > < a href = '#impl-Send' class = 'anchor' > < / a > < / span > < / td > < td > < span class = 'out-of-band' > < / span > < / td > < / tr > < / tbody > < / table > < / h3 > < div class = 'impl-items' > < / div > < h3 id = 'impl-Sync' class = 'impl' > < span class = 'in-band' > < table class = 'table-display' > < tbody > < tr > < td > < code > impl !< a class = "trait" href = "https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title = "trait core::marker::Sync" > Sync< / a > for < a class = "struct" href = "../mentat_ffi/struct.ExternResult.html" title = "struct mentat_ffi::ExternResult" > ExternResult< / a > < / code > < a href = '#impl-Sync' class = 'anchor' > < / a > < / span > < / td > < td > < span class = 'out-of-band' > < / span > < / td > < / tr > < / tbody > < / table > < / h3 > < div class = 'impl-items' > < / div > < / 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 >
