greg/mentat
1
0
Fork 0
Code Issues 294 Pull requests Projects Releases 9 Packages Wiki Activity
mentat/docs/apis/0.7/rust/mentat_ffi/trait.HasSchema.html

158 lines
37 KiB
HTML
Raw Permalink Normal View History

Mentat documentation website using Jekyll (#754) Steps to building docs locally: 1. Install Jekyll 2. cd docs 3. bundle exec jekyll serve --incremental 4. open local docs site at http://127.0.0.1:4000/ * basic Jekyll site * Add docs to documentation site * Update javadoc to allow for error free builds * Remove docs for rust dependencies * Better display examples, about and contributing documentation for Mentat * Version docs
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 `HasSchema` trait in crate `mentat_ffi`.">
<meta name="keywords" content="rust, rustlang, rust-lang, HasSchema">
<title>mentat_ffi::HasSchema - 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 trait">
<!--[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">&#9776;</div>
<p class='location'>Trait HasSchema</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.entid_for_type">entid_for_type</a><a href="#tymethod.get_ident">get_ident</a><a href="#tymethod.get_entid">get_entid</a><a href="#tymethod.attribute_for_entid">attribute_for_entid</a><a href="#tymethod.attribute_for_ident">attribute_for_ident</a><a href="#tymethod.is_attribute">is_attribute</a><a href="#tymethod.identifies_attribute">identifies_attribute</a><a href="#tymethod.component_attributes">component_attributes</a></div><a class="sidebar-title" href="#foreign-impls">Implementations on Foreign Types</a><div class="sidebar-links"><a href="#impl-HasSchema">InProgressRead&lt;&#39;a, &#39;c&gt;</a><a href="#impl-HasSchema">Schema</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='index.html'>mentat_ffi</a></p><script>window.sidebarCurrent = {name: 'HasSchema', ty: 'trait', 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 ‘S’ to search, ‘?’ for more options…"
type="search">
</div>
</form>
</nav>
<section id='main' class="content"><h1 class='fqn'><span class='in-band'>Trait <a href='index.html'>mentat_ffi</a>::<wbr><a class="trait" href=''>HasSchema</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'>&#x2212;</span>]
</a>
</span><a class='srclink' href='../src/mentat_core/lib.rs.html#279-296' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust trait'>pub trait HasSchema {
fn <a href='#tymethod.entid_for_type' class='fnname'>entid_for_type</a>(&amp;self, t: <a class="enum" href="../mentat_ffi/enum.ValueType.html" title="enum mentat_ffi::ValueType">ValueType</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="../mentat_ffi/struct.KnownEntid.html" title="struct mentat_ffi::KnownEntid">KnownEntid</a>&gt;;
<div class='item-spacer'></div> fn <a href='#tymethod.get_ident' class='fnname'>get_ident</a>&lt;T&gt;(&amp;self, x: T) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;&amp;<a class="struct" href="../edn/symbols/struct.Keyword.html" title="struct edn::symbols::Keyword">Keyword</a>&gt;<br>&nbsp;&nbsp;&nbsp; <span class="where">where<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i64.html">i64</a>&gt;</span>;
<div class='item-spacer'></div> fn <a href='#tymethod.get_entid' class='fnname'>get_entid</a>(&amp;self, x: &amp;<a class="struct" href="../edn/symbols/struct.Keyword.html" title="struct edn::symbols::Keyword">Keyword</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="../mentat_ffi/struct.KnownEntid.html" title="struct mentat_ffi::KnownEntid">KnownEntid</a>&gt;;
<div class='item-spacer'></div> fn <a href='#tymethod.attribute_for_entid' class='fnname'>attribute_for_entid</a>&lt;T&gt;(&amp;self, x: T) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;&amp;<a class="struct" href="../mentat_core/struct.Attribute.html" title="struct mentat_core::Attribute">Attribute</a>&gt;<br>&nbsp;&nbsp;&nbsp; <span class="where">where<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i64.html">i64</a>&gt;</span>;
<div class='item-spacer'></div> fn <a href='#tymethod.attribute_for_ident' class='fnname'>attribute_for_ident</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&amp;self, <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;ident: &amp;<a class="struct" href="../edn/symbols/struct.Keyword.html" title="struct edn::symbols::Keyword">Keyword</a><br>&nbsp;&nbsp;&nbsp;&nbsp;) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a>&amp;<a class="struct" href="../mentat_core/struct.Attribute.html" title="struct mentat_core::Attribute">Attribute</a>, <a class="struct" href="../mentat_ffi/struct.KnownEntid.html" title="struct mentat_ffi::KnownEntid">KnownEntid</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>&gt;;
<div class='item-spacer'></div> fn <a href='#tymethod.is_attribute' class='fnname'>is_attribute</a>&lt;T&gt;(&amp;self, x: T) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a><br>&nbsp;&nbsp;&nbsp; <span class="where">where<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i64.html">i64</a>&gt;</span>;
<div class='item-spacer'></div> fn <a href='#tymethod.identifies_attribute' class='fnname'>identifies_attribute</a>(&amp;self, x: &amp;<a class="struct" href="../edn/symbols/struct.Keyword.html" title="struct edn::symbols::Keyword">Keyword</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>;
<div class='item-spacer'></div> fn <a href='#tymethod.component_attributes' class='fnname'>component_attributes</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&amp;[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i64.html">i64</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>;
}</pre></div>
<h2 id='required-methods' class='small-section-header'>
Required Methods<a href='#required-methods' class='anchor'></a>
</h2>
<div class='methods'>
<h3 id='tymethod.entid_for_type' class='method'><span id='entid_for_type.v' class='invisible'><code>fn <a href='#tymethod.entid_for_type' class='fnname'>entid_for_type</a>(&amp;self, t: <a class="enum" href="../mentat_ffi/enum.ValueType.html" title="enum mentat_ffi::ValueType">ValueType</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="../mentat_ffi/struct.KnownEntid.html" title="struct mentat_ffi::KnownEntid">KnownEntid</a>&gt;</code></span></h3><h3 id='tymethod.get_ident' class='method'><span id='get_ident.v' class='invisible'><code>fn <a href='#tymethod.get_ident' class='fnname'>get_ident</a>&lt;T&gt;(&amp;self, x: T) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;&amp;<a class="struct" href="../edn/symbols/struct.Keyword.html" title="struct edn::symbols::Keyword">Keyword</a>&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i64.html">i64</a>&gt;,&nbsp;</span></code></span></h3><h3 id='tymethod.get_entid' class='method'><span id='get_entid.v' class='invisible'><code>fn <a href='#tymethod.get_entid' class='fnname'>get_entid</a>(&amp;self, x: &amp;<a class="struct" href="../edn/symbols/struct.Keyword.html" title="struct edn::symbols::Keyword">Keyword</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="../mentat_ffi/struct.KnownEntid.html" title="struct mentat_ffi::KnownEntid">KnownEntid</a>&gt;</code></span></h3><h3 id='tymethod.attribute_for_entid' class='method'><span id='attribute_for_entid.v' class='invisible'><code>fn <a href='#tymethod.attribute_for_entid' class='fnname'>attribute_for_entid</a>&lt;T&gt;(&amp;self, x: T) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;&amp;<a class="struct" href="../mentat_core/struct.Attribute.html" title="struct mentat_core::Attribute">Attribute</a>&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i64.html">i64</a>&gt;,&nbsp;</span></code></span></h3><h3 id='tymethod.attribute_for_ident' class='method'><span id='attribute_for_ident.v' class='invisible'><code>fn <a href='#tymethod.attribute_for_ident' class='fnname'>attribute_for_ident</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;self, <br>&nbsp;&nbsp;&nbsp;&nbsp;ident: &amp;<a class="struct" href="../edn/symbols/struct.Keyword.html" title="struct edn::symbols::Keyword">Keyword</a><br>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a>&amp;<a class="struct" href="../mentat_core/struct.Attribute.html" title="struct mentat_core::Attribute">Attribute</a>, <a class="struct" href="../mentat_ffi/struct.KnownEntid.html" title="struct mentat_ffi::KnownEntid">KnownEntid</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>&gt;</code></span></h3><h3 id='tymethod.is_attribute' class='method'><span id='is_attribute.v' class='invisible'><code>fn <a href='#tymethod.is_attribute' class='fnname'>is_attribute</a>&lt;T&gt;(&amp;self, x: T) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a> <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: <a class="trait" href="https://doc.rust-lang.org/nightly/
</div><h3 id='tymethod.identifies_attribute' class='method'><span id='identifies_attribute.v' class='invisible'><code>fn <a href='#tymethod.identifies_attribute' class='fnname'>identifies_attribute</a>(&amp;self, x: &amp;<a class="struct" href="../edn/symbols/struct.Keyword.html" title="struct edn::symbols::Keyword">Keyword</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span></h3><div class='docblock'><p>Return true if the provided ident identifies an attribute in this schema.</p>
</div><div class="important-traits"><div class='tooltip'>ⓘ<span class='tooltiptext'>Important traits for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&amp;'a [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a></span></div><div class="content hidden"><h3 class="important">Important traits for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&amp;'a [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a></h3><code class="content"><span class="where fmt-newline">impl&lt;'a&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&amp;'a [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a></span><span class="where fmt-newline">impl&lt;'a&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Write.html" title="trait std::io::Write">Write</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&amp;'a mut [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a></span></code></div></div><h3 id='tymethod.component_attributes' class='method'><span id='component_attributes.v' class='invisible'><code>fn <a href='#tymethod.component_attributes' class='fnname'>component_attributes</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&amp;[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i64.html">i64</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a></code></span></h3></div>
<h2 id='foreign-impls' class='small-section-header'>
Implementations on Foreign Types<a href='#foreign-impls' class='anchor'></a>
</h2>
Fix broken documentation links. (#775) (#767) r=nalexander * Fix broken API doc links Create symlink for latest to point to v0.7. Group APIs by top version number rather than individual * Update swift and android version numbers to match Mentats * Update documentation * Update top level .gitignore to ignore docs site & metatdata * Add README to help with building documentation site * Address review comments @ncalexan
2018-06-29 17:28:44 +00:00
<h3 id='impl-HasSchema' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl&lt;'a, 'c&gt; <a class="trait" href="../mentat_ffi/trait.HasSchema.html" title="trait mentat_ffi::HasSchema">HasSchema</a> for <a class="struct" href="../mentat/conn/struct.InProgressRead.html" title="struct mentat::conn::InProgressRead">InProgressRead</a>&lt;'a, 'c&gt;</code><a href='#impl-HasSchema' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mentat/conn.rs.html#317-351' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><span class='docblock autohide'><div class='impl-items'><h4 id='method.entid_for_type' class="method"><span id='entid_for_type.v-1' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.entid_for_type' class='fnname'>entid_for_type</a>(&amp;self, t: <a class="enum" href="../mentat_ffi/enum.ValueType.html" title="enum mentat_ffi::ValueType">ValueType</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="../mentat_ffi/struct.KnownEntid.html" title="struct mentat_ffi::KnownEntid">KnownEntid</a>&gt;</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mentat/conn.rs.html#318-320' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><h4 id='method.get_ident' class="method"><span id='get_ident.v-1' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.get_ident' class='fnname'>get_ident</a>&lt;T&gt;(&amp;self, x: T) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;&amp;<a class="struct" href="../edn/symbols/struct.Keyword.html" title="struct edn::symbols::Keyword">Keyword</a>&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i64.html">i64</a>&gt;,&nbsp;</span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mentat/conn.rs.html#322-324' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><h4 id='method.get_entid' class="method"><span id='get_entid.v-1' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.get_entid' class='fnname'>get_entid</a>(&amp;self, x: &amp;<a class="struct" href="../edn/symbols/struct.Keyword.html" title="struct edn::symbols::Keyword">Keyword</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="../mentat_ffi/struct.KnownEntid.html" title="struct mentat_ffi::KnownEntid">KnownEntid</a>&gt;</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mentat/conn.rs.html#326-328' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><h4 id='method.attribute_for_entid' class="method"><span id='attribute_for_entid.v-1' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.attribute_for_entid' class='fnname'>attribute_for_entid</a>&lt;T&gt;(&amp;self, x: T) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;&amp;<a class="struct" href="../mentat_core/struct.Attribute.html" title="struct mentat_core::Attribute">Attribute</a>&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i64.html
</div><h4 id='method.identifies_attribute' class="method"><span id='identifies_attribute.v-1' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.identifies_attribute' class='fnname'>identifies_attribute</a>(&amp;self, x: &amp;<a class="struct" href="../edn/symbols/struct.Keyword.html" title="struct edn::symbols::Keyword">Keyword</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mentat/conn.rs.html#344-346' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Return true if the provided ident identifies an attribute in this schema.</p>
</div><h4 id='method.component_attributes' class="method"><div class="important-traits"><div class='tooltip'>ⓘ<span class='tooltiptext'>Important traits for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&amp;'a [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a></span></div><div class="content hidden"><h3 class="important">Important traits for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&amp;'a [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a></h3><code class="content"><span class="where fmt-newline">impl&lt;'a&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&amp;'a [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a></span><span class="where fmt-newline">impl&lt;'a&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Write.html" title="trait std::io::Write">Write</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&amp;'a mut [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a></span></code></div></div><span id='component_attributes.v-1' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.component_attributes' class='fnname'>component_attributes</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&amp;[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i64.html">i64</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mentat/conn.rs.html#348-350' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4></div></span><h3 id='impl-HasSchema-1' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="../mentat_ffi/trait.HasSchema.html" title="trait mentat_ffi::HasSchema">HasSchema</a> for <a class="struct" href="../mentat_core/struct.Schema.html" title="struct mentat_core::Schema">Schema</a></code><a href='#impl-HasSchema-1' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mentat_core/lib.rs.html#328-366' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><span class='docblock autohide'><div class='impl-items'><h4 id='method.entid_for_type-1' class="method"><span id='entid_for_type.v-2' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.entid_for_type' class='fnname'>entid_for_type</a>(&amp;self, t: <a class="enum" href="../mentat_ffi/enum.ValueType.html" title="enum mentat_ffi::ValueType">ValueType</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="../mentat_ffi/struct.KnownEntid.html" title="struct mentat_ffi::KnownEntid">KnownEntid</a>&gt;</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mentat_core/lib.rs.html#329-332' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><h4 id='method.get_ident-1' class="method"><span id='get_ident.v-2' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.get_id
Mentat documentation website using Jekyll (#754) Steps to building docs locally: 1. Install Jekyll 2. cd docs 3. bundle exec jekyll serve --incremental 4. open local docs site at http://127.0.0.1:4000/ * basic Jekyll site * Add docs to documentation site * Update javadoc to allow for error free builds * Remove docs for rust dependencies * Better display examples, about and contributing documentation for Mentat * Version docs
2018-06-25 10:20:36 +00:00
</div><h4 id='method.identifies_attribute-1' class="method"><span id='identifies_attribute.v-2' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.identifies_attribute' class='fnname'>identifies_attribute</a>(&amp;self, x: &amp;<a class="struct" href="../edn/symbols/struct.Keyword.html" title="struct edn::symbols::Keyword">Keyword</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mentat_core/lib.rs.html#359-361' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Return true if the provided ident identifies an attribute in this schema.</p>
</div><h4 id='method.component_attributes-1' class="method"><div class="important-traits"><div class='tooltip'>ⓘ<span class='tooltiptext'>Important traits for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&amp;'a [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a></span></div><div class="content hidden"><h3 class="important">Important traits for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&amp;'a [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a></h3><code class="content"><span class="where fmt-newline">impl&lt;'a&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&amp;'a [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a></span><span class="where fmt-newline">impl&lt;'a&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Write.html" title="trait std::io::Write">Write</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&amp;'a mut [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a></span></code></div></div><span id='component_attributes.v-2' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.component_attributes' class='fnname'>component_attributes</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&amp;[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i64.html">i64</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mentat_core/lib.rs.html#363-365' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4></div></span>
<h2 id='implementors' class='small-section-header'>
Implementors<a href='#implementors' class='anchor'></a>
</h2>
<ul class='item-list' id='implementors-list'>
Fix broken documentation links. (#775) (#767) r=nalexander * Fix broken API doc links Create symlink for latest to point to v0.7. Group APIs by top version number rather than individual * Update swift and android version numbers to match Mentats * Update documentation * Update top level .gitignore to ignore docs site & metatdata * Add README to help with building documentation site * Address review comments @ncalexan
2018-06-29 17:28:44 +00:00
<li><table class='table-display'><tbody><tr><td><code>impl&lt;'a, 'c&gt; HasSchema for <a class="struct" href="../mentat_ffi/struct.InProgress.html" title="struct mentat_ffi::InProgress">InProgress</a>&lt;'a, 'c&gt;</code><td><div class='out-of-band'><a class='srclink' href='../src/mentat/conn.rs.html#353-387' title='goto source code'>[src]</a></div></td></tr></tbody></table></li>
Mentat documentation website using Jekyll (#754) Steps to building docs locally: 1. Install Jekyll 2. cd docs 3. bundle exec jekyll serve --incremental 4. open local docs site at http://127.0.0.1:4000/ * basic Jekyll site * Add docs to documentation site * Update javadoc to allow for error free builds * Remove docs for rust dependencies * Better display examples, about and contributing documentation for Mentat * Version docs
2018-06-25 10:20:36 +00:00
</ul><script type="text/javascript">window.inlined_types=new Set([]);</script><script type="text/javascript" async
src="../implementors/mentat_core/trait.HasSchema.js">
</script></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>&#9166;</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>
Reference in a new issue Copy permalink