175 lines
23 KiB
HTML
175 lines
23 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 `DbError` enum in crate `mentat_db`.">
|
|||
|
|
<meta name="keywords" content="rust, rustlang, rust-lang, DbError">
|
|||
|
|
|
|||
|
|
<title>mentat_db::errors::DbError - 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 enum">
|
|||
|
|
<!--[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'>Enum DbError</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#variants">Variants</a><div class="sidebar-links"><a href="#variant.NotYetImplemented">NotYetImplemented</a><a href="#variant.BadValuePair">BadValuePair</a><a href="#variant.BadSQLValuePair">BadSQLValuePair</a><a href="#variant.BadBootstrapDefinition">BadBootstrapDefinition</a><a href="#variant.BadSchemaAssertion">BadSchemaAssertion</a><a href="#variant.UnrecognizedIdent">UnrecognizedIdent</a><a href="#variant.UnrecognizedEntid">UnrecognizedEntid</a><a href="#variant.UnknownAttribute">UnknownAttribute</a><a href="#variant.CannotCacheNonUniqueAttributeInReverse">CannotCacheNonUniqueAttributeInReverse</a><a href="#variant.SchemaAlterationFailed">SchemaAlterationFailed</a><a href="#variant.SchemaConstraintViolation">SchemaConstraintViolation</a><a href="#variant.InputError">InputError</a><a href="#variant.WrongTypeValueForFtsAssertion">WrongTypeValueForFtsAssertion</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Debug">Debug</a><a href="#impl-Fail">Fail</a><a href="#impl-Display">Display</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_db</a>::<wbr><a href='index.html'>errors</a></p><script>window.sidebarCurrent = {name: 'DbError', ty: 'enum', 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'>Enum <a href='../index.html'>mentat_db</a>::<wbr><a href='index.html'>errors</a>::<wbr><a class="enum" href=''>DbError</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_db/errors.rs.html#147-206' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust enum'>pub enum DbError {
|
|||
|
|
NotYetImplemented(<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>),
|
|||
|
|
BadValuePair(<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>, <a class="enum" href="../../mentat_db/types/enum.ValueType.html" title="enum mentat_db::types::ValueType">ValueType</a>),
|
|||
|
|
BadSQLValuePair(Value, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>),
|
|||
|
|
BadBootstrapDefinition(<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>),
|
|||
|
|
BadSchemaAssertion(<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>),
|
|||
|
|
UnrecognizedIdent(<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>),
|
|||
|
|
UnrecognizedEntid(<a class="type" href="../../mentat_db/types/type.Entid.html" title="type mentat_db::types::Entid">Entid</a>),
|
|||
|
|
UnknownAttribute(<a class="type" href="../../mentat_db/types/type.Entid.html" title="type mentat_db::types::Entid">Entid</a>),
|
|||
|
|
CannotCacheNonUniqueAttributeInReverse(<a class="type" href="../../mentat_db/types/type.Entid.html" title="type mentat_db::types::Entid">Entid</a>),
|
|||
|
|
SchemaAlterationFailed(<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>),
|
|||
|
|
SchemaConstraintViolation(<a class="enum" href="../../mentat_db/errors/enum.SchemaConstraintViolation.html" title="enum mentat_db::errors::SchemaConstraintViolation">SchemaConstraintViolation</a>),
|
|||
|
|
InputError(<a class="enum" href="../../mentat_db/errors/enum.InputError.html" title="enum mentat_db::errors::InputError">InputError</a>),
|
|||
|
|
WrongTypeValueForFtsAssertion,
|
|||
|
|
}</pre></div><h2 id='variants' class='variants small-section-header'>
|
|||
|
|
Variants<a href='#variants' class='anchor'></a></h2>
|
|||
|
|
<span id="variant.NotYetImplemented" class="variant small-section-header"><a href="#variant.NotYetImplemented" class="anchor field"></a><span id='NotYetImplemented.v' class='invisible'><code>NotYetImplemented(<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>)</code></span></span><div class='docblock'><p>We're just not done yet. Message that the feature is recognized but not yet
|
|||
|
|
implemented.</p>
|
|||
|
|
</div><span id="variant.BadValuePair" class="variant small-section-header"><a href="#variant.BadValuePair" class="anchor field"></a><span id='BadValuePair.v' class='invisible'><code>BadValuePair(<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>, <a class="enum" href="../../mentat_db/types/enum.ValueType.html" title="enum mentat_db::types::ValueType">ValueType</a>)</code></span></span><div class='docblock'><p>We've been given a value that isn't the correct Mentat type.</p>
|
|||
|
|
</div><span id="variant.BadSQLValuePair" class="variant small-section-header"><a href="#variant.BadSQLValuePair" class="anchor field"></a><span id='BadSQLValuePair.v' class='invisible'><code>BadSQLValuePair(Value, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>)</code></span></span><div class='docblock'><p>We've got corrupt data in the SQL store: a value and value_type_tag don't line up.
|
|||
|
|
TODO _1.data_type()</p>
|
|||
|
|
</div><span id="variant.BadBootstrapDefinition" class="variant small-section-header"><a href="#variant.BadBootstrapDefinition" class="anchor field"></a><span id='BadBootstrapDefinition.v' class='invisible'><code>BadBootstrapDefinition(<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>)</code></span></span><div class='docblock'><p>A bootstrap definition couldn't be parsed or installed. This is a programmer error, not
|
|||
|
|
a runtime error.</p>
|
|||
|
|
</div><span id="variant.BadSchemaAssertion" class="variant small-section-header"><a href="#variant.BadSchemaAssertion" class="anchor field"></a><span id='BadSchemaAssertion.v' class='invisible'><code>BadSchemaAssertion(<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>)</code></span></span><div class='docblock'><p>A schema assertion couldn't be parsed.</p>
|
|||
|
|
</div><span id="variant.UnrecognizedIdent" class="variant small-section-header"><a href="#variant.UnrecognizedIdent" class="anchor field"></a><span id='UnrecognizedIdent.v' class='invisible'><code>UnrecognizedIdent(<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>)</code></span></span><div class='docblock'><p>An ident->entid mapping failed.</p>
|
|||
|
|
</div><span id="variant.UnrecognizedEntid" class="variant small-section-header"><a href="#variant.UnrecognizedEntid" class="anchor field"></a><span id='UnrecognizedEntid.v' class='invisible'><code>UnrecognizedEntid(<a class="type" href="../../mentat_db/types/type.Entid.html" title="type mentat_db::types::Entid">Entid</a>)</code></span></span><div class='docblock'><p>An entid->ident mapping failed.
|
|||
|
|
We also use this error if you try to transact an entid that we didn't allocate,
|
|||
|
|
in part because we blow the stack in error_chain if we define a new enum!</p>
|
|||
|
|
</div><span id="variant.UnknownAttribute" class="variant small-section-header"><a href="#variant.UnknownAttribute" class="anchor field"></a><span id='UnknownAttribute.v' class='invisible'><code>UnknownAttribute(<a class="type" href="../../mentat_db/types/type.Entid.html" title="type mentat_db::types::Entid">Entid</a>)</code></span></span><span id="variant.CannotCacheNonUniqueAttributeInReverse" class="variant small-section-header"><a href="#variant.CannotCacheNonUniqueAttributeInReverse" class="anchor field"></a><span id='CannotCacheNonUniqueAttributeInReverse.v' class='invisible'><code>CannotCacheNonUniqueAttributeInReverse(<a class="type" href="../../mentat_db/types/type.Entid.html" title="type mentat_db::types::Entid">Entid</a>)</code></span></span><span id="variant.SchemaAlterationFailed" class="variant small-section-header"><a href="#variant.SchemaAlterationFailed" class="anchor field"></a><span id='SchemaAlterationFailed.v' class='invisible'><code>SchemaAlterationFailed(<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>)</code></span></span><span id="variant.SchemaConstraintViolation" class="variant small-section-header"><a href="#variant.SchemaConstraintViolation" class="anchor field"></a><span id='SchemaConstraintViolation.v' class='invisible'><code>SchemaConstraintViolation(<a class="enum" href="../../mentat_db/errors/enum.SchemaConstraintViolation.html" title="enum mentat_db::errors::SchemaConstraintViolation">SchemaConstraintViolation</a>)</code></span></span><div class='docblock'><p>A transaction tried to violate a constraint of the schema of the Mentat store.</p>
|
|||
|
|
</div><span id="variant.InputError" class="variant small-section-header"><a href="#variant.InputError" class="anchor field"></a><span id='InputError.v' class='invisible'><code>InputError(<a class="enum" href="../../mentat_db/errors/enum.InputError.html" title="enum mentat_db::errors::InputError">InputError</a>)</code></span></span><div class='docblock'><p>The transaction was malformed in some way (that was not recognized at parse time; for
|
|||
|
|
example, in a way that is schema-dependent).</p>
|
|||
|
|
</div><span id="variant.WrongTypeValueForFtsAssertion" class="variant small-section-header"><a href="#variant.WrongTypeValueForFtsAssertion" class="anchor field"></a><span id='WrongTypeValueForFtsAssertion.v' class='invisible'><code>WrongTypeValueForFtsAssertion</code></span></span>
|
|||
|
|
<h2 id='implementations' class='small-section-header'>
|
|||
|
|
Trait Implementations<a href='#implementations' class='anchor'></a>
|
|||
|
|
</h2>
|
|||
|
|
<div id='implementations-list'>
|
|||
|
|
<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="enum" href="../../mentat_db/errors/enum.DbError.html" title="enum mentat_db::errors::DbError">DbError</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_db/errors.rs.html#146' 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_db/errors.rs.html#146' 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-Fail' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl Fail for <a class="enum" href="../../mentat_db/errors/enum.DbError.html" title="enum mentat_db::errors::DbError">DbError</a></code><a href='#impl-Fail' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/mentat_db/errors.rs.html#146' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.cause' class="method"><span id='cause.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.cause' class='fnname'>cause</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&Fail></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/mentat_db/errors.rs.html#146' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns a reference to the underlying cause of this failure, if it is an error that wraps other errors. <a href="#method.cause">Read more</a></p>
|
|||
|
|
</div><h4 id='method.backtrace' class="method"><span id='backtrace.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.backtrace' class='fnname'>backtrace</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&Backtrace></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/mentat_db/errors.rs.html#146' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns a reference to the <code>Backtrace</code> carried by this failure, if it carries one. <a href="#method.backtrace">Read more</a></p>
|
|||
|
|
</div><h4 id='method.context' class="method"><span id='context.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.context' class='fnname'>context</a><D>(self, context: D) -> Context<D> <span class="where fmt-newline">where<br> D: <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html" title="trait core::fmt::Display">Display</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> + 'static, </span></code></td><td></td></tr></tbody></table></span></h4><div class='docblock'><p>Provides context for this failure. <a href="#method.context">Read more</a></p>
|
|||
|
|
</div><h4 id='method.compat' class="method"><span id='compat.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.compat' class='fnname'>compat</a>(self) -> Compat<Self></code></td><td></td></tr></tbody></table></span></h4><div class='docblock'><p>Wraps this failure in a compatibility wrapper that implements <code>std::error::Error</code>. <a href="#method.compat">Read more</a></p>
|
|||
|
|
</div><h4 id='method.causes' class="method"><div class="important-traits"><div class='tooltip'>ⓘ<span class='tooltiptext'>Important traits for Causes<'f></span></div><div class="content hidden"><h3 class="important">Important traits for Causes<'f></h3><code class="content"><span class="where fmt-newline">impl<'f> <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a> for Causes<'f></span><span class="where fmt-newline"> type <a href='https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html#associatedtype.Item' class="type">Item</a> = &'f (Fail + 'static);</span></code></div></div><span id='causes.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.causes' class='fnname'>causes</a>(&self) -> Causes</code></td><td></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns a iterator over the causes of this <code>Fail</code> with itself as the first item and the <code>root_cause</code> as the final item. <a href="#method.causes">Read more</a></p>
|
|||
|
|
</div><h4 id='method.root_cause' class="method"><span id='root_cause.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.root_cause' class='fnname'>root_cause</a>(&self) -> &(Fail + 'static)</code></td><td></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns the "root cause" of this <code>Fail</code> - the last value in the cause chain which does not return an underlying <code>cause</code>. <a href="#method.root_cause">Read more</a></p>
|
|||
|
|
</div></div><h3 id='impl-Display' 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.Display.html" title="trait core::fmt::Display">Display</a> for <a class="enum" href="../../mentat_db/errors/enum.DbError.html" title="enum mentat_db::errors::DbError">DbError</a></code><a href='#impl-Display' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/mentat_db/errors.rs.html#146' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.fmt-1' class="method"><span id='fmt.v-1' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html#tymethod.fmt' class='fnname'>fmt</a>(&self, f: &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_db/errors.rs.html#146' 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.Display.html#tymethod.fmt">Read more</a></p>
|
|||
|
|
</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="enum" href="../../mentat_db/errors/enum.DbError.html" title="enum mentat_db::errors::DbError">DbError</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="enum" href="../../mentat_db/errors/enum.DbError.html" title="enum mentat_db::errors::DbError">DbError</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_db";
|
|||
|
|
</script>
|
|||
|
|
<script src="../../main.js"></script>
|
|||
|
|
<script defer src="../../search-index.js"></script>
|
|||
|
|
</body>
|
|||
|
|
</html>
|