da599c3a78
* 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
172 lines
No EOL
22 KiB
HTML
172 lines
No EOL
22 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 `Pattern` struct in crate `edn`.">
|
||
<meta name="keywords" content="rust, rustlang, rust-lang, Pattern">
|
||
|
||
<title>edn::query::Pattern - 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 Pattern</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#fields">Fields</a><div class="sidebar-links"><a href="#structfield.source">source</a><a href="#structfield.entity">entity</a><a href="#structfield.attribute">attribute</a><a href="#structfield.value">value</a><a href="#structfield.tx">tx</a></div><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.simple">simple</a><a href="#method.new">new</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Clone">Clone</a><a href="#impl-Debug">Debug</a><a href="#impl-Eq">Eq</a><a href="#impl-PartialEq">PartialEq</a><a href="#impl-ContainsVariables">ContainsVariables</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'>edn</a>::<wbr><a href='index.html'>query</a></p><script>window.sidebarCurrent = {name: 'Pattern', 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 ‘S’ to search, ‘?’ for more options…"
|
||
type="search">
|
||
</div>
|
||
</form>
|
||
</nav>
|
||
|
||
<section id='main' class="content"><h1 class='fqn'><span class='in-band'>Struct <a href='../index.html'>edn</a>::<wbr><a href='index.html'>query</a>::<wbr><a class="struct" href=''>Pattern</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/edn/query.rs.html#820-826' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust struct'>pub struct Pattern {
|
||
pub source: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="enum" href="../../edn/query/enum.SrcVar.html" title="enum edn::query::SrcVar">SrcVar</a>>,
|
||
pub entity: <a class="enum" href="../../edn/query/enum.PatternNonValuePlace.html" title="enum edn::query::PatternNonValuePlace">PatternNonValuePlace</a>,
|
||
pub attribute: <a class="enum" href="../../edn/query/enum.PatternNonValuePlace.html" title="enum edn::query::PatternNonValuePlace">PatternNonValuePlace</a>,
|
||
pub value: <a class="enum" href="../../edn/query/enum.PatternValuePlace.html" title="enum edn::query::PatternValuePlace">PatternValuePlace</a>,
|
||
pub tx: <a class="enum" href="../../edn/query/enum.PatternNonValuePlace.html" title="enum edn::query::PatternNonValuePlace">PatternNonValuePlace</a>,
|
||
}</pre></div><h2 id='fields' class='fields small-section-header'>
|
||
Fields<a href='#fields' class='anchor'></a></h2><span id="structfield.source" class="structfield small-section-header">
|
||
<a href="#structfield.source" class="anchor field"></a>
|
||
<span id="source.v" class='invisible'>
|
||
<code>source: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="enum" href="../../edn/query/enum.SrcVar.html" title="enum edn::query::SrcVar">SrcVar</a>></code>
|
||
</span></span><span id="structfield.entity" class="structfield small-section-header">
|
||
<a href="#structfield.entity" class="anchor field"></a>
|
||
<span id="entity.v" class='invisible'>
|
||
<code>entity: <a class="enum" href="../../edn/query/enum.PatternNonValuePlace.html" title="enum edn::query::PatternNonValuePlace">PatternNonValuePlace</a></code>
|
||
</span></span><span id="structfield.attribute" class="structfield small-section-header">
|
||
<a href="#structfield.attribute" class="anchor field"></a>
|
||
<span id="attribute.v" class='invisible'>
|
||
<code>attribute: <a class="enum" href="../../edn/query/enum.PatternNonValuePlace.html" title="enum edn::query::PatternNonValuePlace">PatternNonValuePlace</a></code>
|
||
</span></span><span id="structfield.value" class="structfield small-section-header">
|
||
<a href="#structfield.value" class="anchor field"></a>
|
||
<span id="value.v" class='invisible'>
|
||
<code>value: <a class="enum" href="../../edn/query/enum.PatternValuePlace.html" title="enum edn::query::PatternValuePlace">PatternValuePlace</a></code>
|
||
</span></span><span id="structfield.tx" class="structfield small-section-header">
|
||
<a href="#structfield.tx" class="anchor field"></a>
|
||
<span id="tx.v" class='invisible'>
|
||
<code>tx: <a class="enum" href="../../edn/query/enum.PatternNonValuePlace.html" title="enum edn::query::PatternNonValuePlace">PatternNonValuePlace</a></code>
|
||
</span></span>
|
||
<h2 id='methods' class='small-section-header'>
|
||
Methods<a href='#methods' class='anchor'></a>
|
||
</h2>
|
||
<h3 id='impl' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="struct" href="../../edn/query/struct.Pattern.html" title="struct edn::query::Pattern">Pattern</a></code><a href='#impl' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/edn/query.rs.html#828-868' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.simple' class="method"><span id='simple.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.simple' class='fnname'>simple</a>(<br> e: <a class="enum" href="../../edn/query/enum.PatternNonValuePlace.html" title="enum edn::query::PatternNonValuePlace">PatternNonValuePlace</a>, <br> a: <a class="enum" href="../../edn/query/enum.PatternNonValuePlace.html" title="enum edn::query::PatternNonValuePlace">PatternNonValuePlace</a>, <br> v: <a class="enum" href="../../edn/query/enum.PatternValuePlace.html" title="enum edn::query::PatternValuePlace">PatternValuePlace</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="struct" href="../../edn/query/struct.Pattern.html" title="struct edn::query::Pattern">Pattern</a>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/edn/query.rs.html#829-833' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><h4 id='method.new' class="method"><span id='new.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.new' class='fnname'>new</a>(<br> src: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="enum" href="../../edn/query/enum.SrcVar.html" title="enum edn::query::SrcVar">SrcVar</a>>, <br> e: <a class="enum" href="../../edn/query/enum.PatternNonValuePlace.html" title="enum edn::query::PatternNonValuePlace">PatternNonValuePlace</a>, <br> a: <a class="enum" href="../../edn/query/enum.PatternNonValuePlace.html" title="enum edn::query::PatternNonValuePlace">PatternNonValuePlace</a>, <br> v: <a class="enum" href="../../edn/query/enum.PatternValuePlace.html" title="enum edn::query::PatternValuePlace">PatternValuePlace</a>, <br> tx: <a class="enum" href="../../edn/query/enum.PatternNonValuePlace.html" title="enum edn::query::PatternNonValuePlace">PatternNonValuePlace</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="struct" href="../../edn/query/struct.Pattern.html" title="struct edn::query::Pattern">Pattern</a>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/edn/query.rs.html#835-867' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4></div>
|
||
<h2 id='implementations' class='small-section-header'>
|
||
Trait Implementations<a href='#implementations' class='anchor'></a>
|
||
</h2>
|
||
<div id='implementations-list'>
|
||
<h3 id='impl-Clone' 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/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="struct" href="../../edn/query/struct.Pattern.html" title="struct edn::query::Pattern">Pattern</a></code><a href='#impl-Clone' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/edn/query.rs.html#819' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.clone' class="method"><span id='clone.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone' class='fnname'>clone</a>(&self) -> <a class="struct" href="../../edn/query/struct.Pattern.html" title="struct edn::query::Pattern">Pattern</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/edn/query.rs.html#819' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns a copy of the value. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone">Read more</a></p>
|
||
</div><h4 id='method.clone_from' class="method"><span id='clone_from.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from' class='fnname'>clone_from</a>(&mut self, source: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Self)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><div class='since' title='Stable since Rust version 1.0.0'>1.0.0</div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/clone.rs.html#117-119' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from">Read more</a></p>
|
||
</div></div><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="../../edn/query/struct.Pattern.html" title="struct edn::query::Pattern">Pattern</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/edn/query.rs.html#819' 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/edn/query.rs.html#819' 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-Eq' 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/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</a> for <a class="struct" href="../../edn/query/struct.Pattern.html" title="struct edn::query::Pattern">Pattern</a></code><a href='#impl-Eq' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/edn/query.rs.html#819' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'></div><h3 id='impl-PartialEq' 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/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a> for <a class="struct" href="../../edn/query/struct.Pattern.html" title="struct edn::query::Pattern">Pattern</a></code><a href='#impl-PartialEq' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/edn/query.rs.html#819' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.eq' class="method"><span id='eq.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq' class='fnname'>eq</a>(&self, __arg_0: &<a class="struct" href="../../edn/query/struct.Pattern.html" title="struct edn::query::Pattern">Pattern</a>) -> <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/edn/query.rs.html#819' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>This method tests for <code>self</code> and <code>other</code> values to be equal, and is used by <code>==</code>. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq">Read more</a></p>
|
||
</div><h4 id='method.ne' class="method"><span id='ne.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#method.ne' class='fnname'>ne</a>(&self, __arg_0: &<a class="struct" href="../../edn/query/struct.Pattern.html" title="struct edn::query::Pattern">Pattern</a>) -> <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/edn/query.rs.html#819' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>This method tests for <code>!=</code>.</p>
|
||
</div></div><h3 id='impl-ContainsVariables' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="../../edn/query/trait.ContainsVariables.html" title="trait edn::query::ContainsVariables">ContainsVariables</a> for <a class="struct" href="../../edn/query/struct.Pattern.html" title="struct edn::query::Pattern">Pattern</a></code><a href='#impl-ContainsVariables' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/edn/query.rs.html#1224-1239' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.accumulate_mentioned_variables' class="method"><span id='accumulate_mentioned_variables.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../edn/query/trait.ContainsVariables.html#tymethod.accumulate_mentioned_variables' class='fnname'>accumulate_mentioned_variables</a>(&self, acc: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/btree/set/struct.BTreeSet.html" title="struct alloc::btree::set::BTreeSet">BTreeSet</a><<a class="struct" href="../../edn/query/struct.Variable.html" title="struct edn::query::Variable">Variable</a>>)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/edn/query.rs.html#1225-1238' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><h4 id='method.collect_mentioned_variables' class="method"><span id='collect_mentioned_variables.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../edn/query/trait.ContainsVariables.html#method.collect_mentioned_variables' class='fnname'>collect_mentioned_variables</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/btree/set/struct.BTreeSet.html" title="struct alloc::btree::set::BTreeSet">BTreeSet</a><<a class="struct" href="../../edn/query/struct.Variable.html" title="struct edn::query::Variable">Variable</a>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/edn/query.rs.html#1102-1106' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4></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="../../edn/query/struct.Pattern.html" title="struct edn::query::Pattern">Pattern</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="../../edn/query/struct.Pattern.html" title="struct edn::query::Pattern">Pattern</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 = "edn";
|
||
</script>
|
||
<script src="../../main.js"></script>
|
||
<script defer src="../../search-index.js"></script>
|
||
</body>
|
||
</html> |