150 lines
18 KiB
HTML
150 lines
18 KiB
HTML
|
<!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_core`.">
|
|||
|
|
<meta name="keywords" content="rust, rustlang, rust-lang, HasSchema">
|
|||
|
|
|
|||
|
|
<title>mentat_core::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">☰</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="#implementors">Implementors</a></div><p class='location'><a href='index.html'>mentat_core</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_core</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'>−</span>]
|
|||
|
|
</a>
|
|||
|
|
</span><a class='srclink' href='../src/mentat_core/lib.rs.html#278-295' 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>(&self, t: <a class="enum" href="../mentat_core/enum.ValueType.html" title="enum mentat_core::ValueType">ValueType</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="../mentat_core/struct.KnownEntid.html" title="struct mentat_core::KnownEntid">KnownEntid</a>>;
|
|||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.get_ident' class='fnname'>get_ident</a><T>(&self, x: T) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&<a class="struct" href="../mentat_core/struct.Keyword.html" title="struct mentat_core::Keyword">Keyword</a>><br> <span class="where">where<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="type" href="../mentat_core/type.Entid.html" title="type mentat_core::Entid">Entid</a>></span>;
|
|||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.get_entid' class='fnname'>get_entid</a>(&self, x: &<a class="struct" href="../mentat_core/struct.Keyword.html" title="struct mentat_core::Keyword">Keyword</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="../mentat_core/struct.KnownEntid.html" title="struct mentat_core::KnownEntid">KnownEntid</a>>;
|
|||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.attribute_for_entid' class='fnname'>attribute_for_entid</a><T>(&self, x: T) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&<a class="struct" href="../mentat_core/struct.Attribute.html" title="struct mentat_core::Attribute">Attribute</a>><br> <span class="where">where<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="type" href="../mentat_core/type.Entid.html" title="type mentat_core::Entid">Entid</a>></span>;
|
|||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.attribute_for_ident' class='fnname'>attribute_for_ident</a>(<br> &self, <br> ident: &<a class="struct" href="../mentat_core/struct.Keyword.html" title="struct mentat_core::Keyword">Keyword</a><br> ) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a>&<a class="struct" href="../mentat_core/struct.Attribute.html" title="struct mentat_core::Attribute">Attribute</a>, <a class="struct" href="../mentat_core/struct.KnownEntid.html" title="struct mentat_core::KnownEntid">KnownEntid</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>>;
|
|||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.is_attribute' class='fnname'>is_attribute</a><T>(&self, x: T) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a><br> <span class="where">where<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="type" href="../mentat_core/type.Entid.html" title="type mentat_core::Entid">Entid</a>></span>;
|
|||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.identifies_attribute' class='fnname'>identifies_attribute</a>(&self, x: &<a class="struct" href="../mentat_core/struct.Keyword.html" title="struct mentat_core::Keyword">Keyword</a>) -> <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>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</a><a class="type" href="../mentat_core/type.Entid.html" title="type mentat_core::Entid">Entid</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>(&self, t: <a class="enum" href="../mentat_core/enum.ValueType.html" title="enum mentat_core::ValueType">ValueType</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="../mentat_core/struct.KnownEntid.html" title="struct mentat_core::KnownEntid">KnownEntid</a>></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><T>(&self, x: T) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&<a class="struct" href="../mentat_core/struct.Keyword.html" title="struct mentat_core::Keyword">Keyword</a>> <span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="type" href="../mentat_core/type.Entid.html" title="type mentat_core::Entid">Entid</a>>, </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>(&self, x: &<a class="struct" href="../mentat_core/struct.Keyword.html" title="struct mentat_core::Keyword">Keyword</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="../mentat_core/struct.KnownEntid.html" title="struct mentat_core::KnownEntid">KnownEntid</a>></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><T>(&self, x: T) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&<a class="struct" href="../mentat_core/struct.Attribute.html" title="struct mentat_core::Attribute">Attribute</a>> <span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="type" href="../mentat_core/type.Entid.html" title="type mentat_core::Entid">Entid</a>>, </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> &self, <br> ident: &<a class="struct" href="../mentat_core/struct.Keyword.html" title="struct mentat_core::Keyword">Keyword</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a>&<a class="struct" href="../mentat_core/struct.Attribute.html" title="struct mentat_core::Attribute">Attribute</a>, <a class="struct" href="../mentat_core/struct.KnownEntid.html" title="struct mentat_core::KnownEntid">KnownEntid</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>></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><T>(&self, x: T) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a> <span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.o
|
|||
|
|
</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>(&self, x: &<a class="struct" href="../mentat_core/struct.Keyword.html" title="struct mentat_core::Keyword">Keyword</a>) -> <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">&'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">&'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<'a> <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">&'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<'a> <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">&'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>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</a><a class="type" href="../mentat_core/type.Entid.html" title="type mentat_core::Entid">Entid</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a></code></span></h3></div>
|
|||
|
|
<h2 id='implementors' class='small-section-header'>
|
|||
|
|
Implementors<a href='#implementors' class='anchor'></a>
|
|||
|
|
</h2>
|
|||
|
|
<ul class='item-list' id='implementors-list'>
|
|||
|
|
<li><table class='table-display'><tbody><tr><td><code>impl HasSchema for <a class="struct" href="../mentat_core/struct.Schema.html" title="struct mentat_core::Schema">Schema</a></code><td><div class='out-of-band'><a class='srclink' href='../src/mentat_core/lib.rs.html#327-365' title='goto source code'>[src]</a></div></td></tr></tbody></table></li>
|
|||
|
|
</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>⏎</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_core";
|
|||
|
|
</script>
|
|||
|
|
<script src="../main.js"></script>
|
|||
|
|
<script defer src="../search-index.js"></script>
|
|||
|
|
</body>
|
|||
|
|
</html>
|