mirror of
https://github.com/edg-l/edlang.git
synced 2024-09-20 01:24:23 +00:00
30 lines
24 KiB
HTML
30 lines
24 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="A trait implemented by `Source` caches."><title>Cache in ariadne - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../static.files/rustdoc-ac92e1bbe349e143.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="ariadne" data-themes="" data-resource-suffix="" data-rustdoc-version="1.76.0 (07dca489a 2024-02-04)" data-channel="1.76.0" data-search-js="search-2b6ce74ff89ae146.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../static.files/storage-f2adc0d6ca4d09fb.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-305769736d49e732.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-feafe1bb7466e4bd.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc trait"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../ariadne/index.html">ariadne</a><span class="version">0.4.0</span></h2></div><h2 class="location"><a href="#">Cache</a></h2><div class="sidebar-elems"><section><h3><a href="#required-associated-types">Required Associated Types</a></h3><ul class="block"><li><a href="#associatedtype.Storage">Storage</a></li></ul><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.display">display</a></li><li><a href="#tymethod.fetch">fetch</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-Cache%3CId%3E-for-%26mut+C">&'b mut C</a></li><li><a href="#impl-Cache%3CId%3E-for-(Id,+Source%3CI%3E)">(Id, Source<I>)</a></li><li><a href="#impl-Cache%3CId%3E-for-Box%3CC%3E">Box<C></a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In crate ariadne</a></h2></div></nav><div class="sidebar-resizer"></div>
|
|||
|
|
<main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../ariadne/all.html" title="show sidebar"></a></div><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" tabindex="-1"><a href="../help.html" title="help">?</a></div><div id="settings-menu" tabindex="-1"><a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Trait <a href="index.html">ariadne</a>::<wbr><a class="trait" href="#">Cache</a><button id="copy-path" title="Copy item path to clipboard"><img src="../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../src/ariadne/source.rs.html#10-27">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub trait Cache<Id: ?<a class="trait" href="https://doc.rust-lang.org/1.76.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>> {
|
|||
|
|
type <a href="#associatedtype.Storage" class="associatedtype">Storage</a>: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a><<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.str.html">str</a>>;
|
|||
|
|
|
|||
|
|
// Required methods
|
|||
|
|
fn <a href="#tymethod.fetch" class="fn">fetch</a>(
|
|||
|
|
&mut self,
|
|||
|
|
id: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.reference.html">&Id</a>
|
|||
|
|
) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><&<a class="struct" href="struct.Source.html" title="struct ariadne::Source">Source</a><Self::<a class="associatedtype" href="trait.Cache.html#associatedtype.Storage" title="type ariadne::Cache::Storage">Storage</a>>, <a class="struct" href="https://doc.rust-lang.org/1.76.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><dyn <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> + '_>>;
|
|||
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.display" class="fn">display</a><'a>(&self, id: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.reference.html">&'a Id</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="https://doc.rust-lang.org/1.76.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><dyn <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/fmt/trait.Display.html" title="trait core::fmt::Display">Display</a> + 'a>>;
|
|||
|
|
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A trait implemented by <a href="struct.Source.html" title="struct ariadne::Source"><code>Source</code></a> caches.</p>
|
|||
|
|
</div></details><h2 id="required-associated-types" class="section-header">Required Associated Types<a href="#required-associated-types" class="anchor">§</a></h2><div class="methods"><details class="toggle" open><summary><section id="associatedtype.Storage" class="method"><a class="src rightside" href="../src/ariadne/source.rs.html#16">source</a><h4 class="code-header">type <a href="#associatedtype.Storage" class="associatedtype">Storage</a>: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a><<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.str.html">str</a>></h4></section></summary><div class="docblock"><p>The type used to store the string data for this cache.</p>
|
|||
|
|
<p>Alternative types other than String can be used, but at the moment, the storage must be
|
|||
|
|
contiguous. A primary use case for this is to use a reference-counted string instead of
|
|||
|
|
copying the whole contents into a <a href="struct.Source.html" title="struct ariadne::Source"><code>Source</code></a>.</p>
|
|||
|
|
</div></details></div><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="tymethod.fetch" class="method"><a class="src rightside" href="../src/ariadne/source.rs.html#20">source</a><h4 class="code-header">fn <a href="#tymethod.fetch" class="fn">fetch</a>(
|
|||
|
|
&mut self,
|
|||
|
|
id: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.reference.html">&Id</a>
|
|||
|
|
) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><&<a class="struct" href="struct.Source.html" title="struct ariadne::Source">Source</a><Self::<a class="associatedtype" href="trait.Cache.html#associatedtype.Storage" title="type ariadne::Cache::Storage">Storage</a>>, <a class="struct" href="https://doc.rust-lang.org/1.76.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><dyn <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> + '_>></h4></section></summary><div class="docblock"><p>Fetch the <a href="struct.Source.html" title="struct ariadne::Source"><code>Source</code></a> identified by the given ID, if possible.</p>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.display" class="method"><a class="src rightside" href="../src/ariadne/source.rs.html#26">source</a><h4 class="code-header">fn <a href="#tymethod.display" class="fn">display</a><'a>(&self, id: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.reference.html">&'a Id</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="https://doc.rust-lang.org/1.76.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><dyn <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/fmt/trait.Display.html" title="trait core::fmt::Display">Display</a> + 'a>></h4></section></summary><div class="docblock"><p>Display the given ID. as a single inline value.</p>
|
|||
|
|
<p>This function may make use of attributes from the <a href="trait.Fmt.html" title="trait ariadne::Fmt"><code>Fmt</code></a> trait.</p>
|
|||
|
|
</div></details></div><h2 id="foreign-impls" class="section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor">§</a></h2><details class="toggle implementors-toggle"><summary><section id="impl-Cache%3CId%3E-for-%26mut+C" class="impl"><a class="src rightside" href="../src/ariadne/source.rs.html#29-34">source</a><a href="#impl-Cache%3CId%3E-for-%26mut+C" class="anchor">§</a><h3 class="code-header">impl<'b, C: <a class="trait" href="trait.Cache.html" title="trait ariadne::Cache">Cache</a><Id>, Id: ?<a class="trait" href="https://doc.rust-lang.org/1.76.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>> <a class="trait" href="trait.Cache.html" title="trait ariadne::Cache">Cache</a><Id> for <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.reference.html">&'b mut C</a></h3></section></summary><div class="impl-items"><section id="associatedtype.Storage-1" class="associatedtype trait-impl"><a href="#associatedtype.Storage-1" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Storage" class="associatedtype">Storage</a> = <C as <a class="trait" href="trait.Cache.html" title="trait ariadne::Cache">Cache</a><Id>>::<a class="associatedtype" href="trait.Cache.html#associatedtype.Storage" title="type ariadne::Cache::Storage">Storage</a></h4></section><section id="method.fetch" class="method trait-impl"><a class="src rightside" href="../src/ariadne/source.rs.html#32">source</a><a href="#method.fetch" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.fetch" class="fn">fetch</a>(
|
|||
|
|
&mut self,
|
|||
|
|
id: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.reference.html">&Id</a>
|
|||
|
|
) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><&<a class="struct" href="struct.Source.html" title="struct ariadne::Source">Source</a><Self::<a class="associatedtype" href="trait.Cache.html#associatedtype.Storage" title="type ariadne::Cache::Storage">Storage</a>>, <a class="struct" href="https://doc.rust-lang.org/1.76.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><dyn <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> + '_>></h4></section><section id="method.display" class="method trait-impl"><a class="src rightside" href="../src/ariadne/source.rs.html#33">source</a><a href="#method.display" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.display" class="fn">display</a><'a>(&self, id: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.reference.html">&'a Id</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="https://doc.rust-lang.org/1.76.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><dyn <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/fmt/trait.Display.html" title="trait core::fmt::Display">Display</a> + 'a>></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Cache%3CId%3E-for-Box%3CC%3E" class="impl"><a class="src rightside" href="../src/ariadne/source.rs.html#36-41">source</a><a href="#impl-Cache%3CId%3E-for-Box%3CC%3E" class="anchor">§</a><h3 class="code-header">impl<C: <a class="trait" href="trait.Cache.html" title="trait ariadne::Cache">Cache</a><Id>, Id: ?<a class="trait" href="https://doc.rust-lang.org/1.76.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>> <a class="trait" href="trait.Cache.html" title="trait ariadne::Cache">Cache</a><Id> for <a class="struct" href="https://doc.rust-lang.org/1.76.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><C></h3></section></summary><div class="impl-items"><section id="associatedtype.Storage-2" class="associatedtype trait-impl"><a href="#associatedtype.Storage-2" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Storage" class="associatedtype">Storage</a> = <C as <a class="trait" href="trait.Cache.html" title="trait ariadne::Cache">Cache</a><Id>>::<a class="associatedtype" href="trait.Cache.html#associatedtype.Storage" title="type ariadne::Cache::Storage">Storage</a></h4></section><section id="method.fetch-1" class="method trait-impl"><a class="src rightside" href="../src/ariadne/source.rs.html#39">source</a><a href="#method.fetch-1" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.fetch" class="fn">fetch</a>(
|
|||
|
|
&mut self,
|
|||
|
|
id: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.reference.html">&Id</a>
|
|||
|
|
) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><&<a class="struct" href="struct.Source.html" title="struct ariadne::Source">Source</a><Self::<a class="associatedtype" href="trait.Cache.html#associatedtype.Storage" title="type ariadne::Cache::Storage">Storage</a>>, <a class="struct" href="https://doc.rust-lang.org/1.76.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><dyn <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> + '_>></h4></section><section id="method.display-1" class="method trait-impl"><a class="src rightside" href="../src/ariadne/source.rs.html#40">source</a><a href="#method.display-1" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.display" class="fn">display</a><'a>(&self, id: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.reference.html">&'a Id</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="https://doc.rust-lang.org/1.76.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><dyn <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/fmt/trait.Display.html" title="trait core::fmt::Display">Display</a> + 'a>></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Cache%3CId%3E-for-(Id,+Source%3CI%3E)" class="impl"><a class="src rightside" href="../src/ariadne/source.rs.html#197-208">source</a><a href="#impl-Cache%3CId%3E-for-(Id,+Source%3CI%3E)" class="anchor">§</a><h3 class="code-header">impl<I: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a><<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.str.html">str</a>>, Id: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/fmt/trait.Display.html" title="trait core::fmt::Display">Display</a> + <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</a>> <a class="trait" href="trait.Cache.html" title="trait ariadne::Cache">Cache</a><Id> for (Id, <a class="struct" href="struct.Source.html" title="struct ariadne::Source">Source</a><I>)</h3></section></summary><div class="impl-items"><section id="associatedtype.Storage-3" class="associatedtype trait-impl"><a href="#associatedtype.Storage-3" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Storage" class="associatedtype">Storage</a> = I</h4></section><section id="method.fetch-2" class="method trait-impl"><a class="src rightside" href="../src/ariadne/source.rs.html#200-206">source</a><a href="#method.fetch-2" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.fetch" class="fn">fetch</a>(&mut self, id: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.reference.html">&Id</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><&<a class="struct" href="struct.Source.html" title="struct ariadne::Source">Source</a><I>, <a class="struct" href="https://doc.rust-lang.org/1.76.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><dyn <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> + '_>></h4></section><section id="method.display-2" class="method trait-impl"><a class="src rightside" href="../src/ariadne/source.rs.html#207">source</a><a href="#method.display-2" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.display" class="fn">display</a><'a>(&self, id: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.reference.html">&'a Id</a>) -> <a class="enum" h
|
|||
|
|
I: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a><<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.str.html">str</a>>,
|
|||
|
|
F: for<'a> <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.reference.html">&'a Id</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><I, <a class="struct" href="https://doc.rust-lang.org/1.76.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><dyn <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a>>>,</div></h3></section></summary><div class="impl-items"><section id="associatedtype.Storage-6" class="associatedtype trait-impl"><a href="#associatedtype.Storage-6" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Storage" class="associatedtype">Storage</a> = I</h4></section></div></details></div><script src="../trait.impl/ariadne/source/trait.Cache.js" data-ignore-extern-crates="std,alloc" async></script></section></div></main></body></html>
|