<!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 `Memoized` enum in crate `memoization`.">
<meta name="keywords" content="rust, rustlang, rust-lang, Memoized">
<title>memoization::Memoized - Rust</title>
<link rel="stylesheet" type="text/css" href="../rustdoc.css">
<link rel="stylesheet" type="text/css" href="../main.css">
</head>
<body class="rustdoc">
<!--[if lte IE 8]>
<div class="warning">
This old browser is unsupported and will most likely display funky
things.
</div>
<![endif]-->
<nav class="sidebar">
<p class='location'><a href='index.html'>memoization</a></p><script>window.sidebarCurrent = {name: 'Memoized', ty: 'enum', relpath: ''};</script><script defer src="sidebar-items.js"></script>
</nav>
<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 enum">
<h1 class='fqn'><span class='in-band'>Enum <a href='index.html'>memoization</a>::<wbr><a class='enum' href=''>Memoized</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 id='src-9' class='srclink' href='../src/memoization/src/lib.rs.html#59-62' title='goto source code'>[src]</a></span></h1>
<pre class='rust enum'>pub enum Memoized<I: 'static, O: <a class='trait' href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html' title='core::clone::Clone'>Clone</a>, Func: <a class='trait' href='https://doc.rust-lang.org/nightly/core/ops/trait.Fn.html' title='core::ops::Fn'>Fn</a>(I) -> O> {
UnInitialized(<a class='struct' href='https://doc.rust-lang.org/nightly/core/marker/struct.PhantomData.html' title='core::marker::PhantomData'>PhantomData</a><&'static I>, <a class='struct' href='https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html' title='alloc::boxed::Box'>Box</a><Func>),
Processed(O),
}</pre><div class='docblock'><p>The enumerator that holds data. In its pre-processed state it holds a
pointer to the lambda that assigns its future constant value. </p>
<pre class='rust rust-example-rendered'>
<span class='kw'>use</span> <span class='ident'>memoization</span>::<span class='ident'>Memoized</span>;
<span class='kw'>struct</span> <span class='ident'>Example</span><span class='op'><</span><span class='ident'>I</span>:<span class='lifetime'>'static</span>, <span class='ident'>O</span>: <span class='ident'>Clone</span>, <span class='ident'>F</span>: <span class='ident'>Fn</span>(<span class='ident'>I</span>) <span class='op'>-></span> <span class='ident'>O</span><span class='op'>></span> {
<span class='ident'>data</span>: <span class='ident'>Memoized</span><span class='op'><</span><span class='ident'>I</span>,<span class='ident'>O</span>,<span class='ident'>F</span><span class='op'>></span>
}
<span class='kw'>fn</span> <span class='ident'>eq_str</span>(<span class='ident'>a</span>: <span class='kw-2'>&</span><span class='ident'>str</span>, <span class='ident'>b</span>: <span class='kw-2'>&</span><span class='ident'>str</span>) <span class='op'>-></span> <span class='ident'>bool</span> {
<span class='ident'>a</span> <span class='op'>==</span> <span class='ident'>b</span>
}
<span class='kw'>let</span> <span class='ident'>lambda</span> <span class='op'>=</span> <span class='op'>|</span><span class='ident'>x</span>: <span class='ident'>i32</span> <span class='op'>|</span> <span class='op'>-></span> <span class='ident'>String</span> {
<span class='ident'>x</span>.<span class='ident'>to_string</span>()
};
<span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>dut</span> <span class='op'>=</span> <span class='ident'>Example</span> {
<span class='ident'>data</span>: <span class='ident'>Memoized</span>::<span class='ident'>new</span>(<span class='ident'>lambda</span>)
};
<span class='comment'>//field is memoized but it can still be written too.</span>
<span class='op'>*</span><span class='ident'>dut</span>.<span class='ident'>data</span> <span class='op'>=</span> <span class='string'>"9001"</span>.<span class='ident'>to_string</span>();
<span class='comment'>//field can be borrowed as its output data type.</span>
<span class='macro'>assert</span><span class='macro'>!</span>( <span class='ident'>eq_str</span>( <span class='kw-2'>&</span><span class='ident'>dut</span>.<span class='ident'>data</span>, <span class='string'>"9001"</span>) );</pre>
</div><h2 class='variants'>Variants</h2>
<span id='variant.UnInitialized' class='variant'><code>UnInitialized(<a class='struct' href='https://doc.rust-lang.org/nightly/core/marker/struct.PhantomData.html' title='core::marker::PhantomData'>PhantomData</a><&'static I>, <a class='struct' href='https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html' title='alloc::boxed::Box'>Box</a><Func>)</code></span><span id='variant.Processed' class='variant'><code>Processed(O)</code></span><h2 id='methods'>Methods</h2><h3 class='impl'><span class='in-band'><code>impl<I: 'static, O: <a class='trait' href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html' title='core::clone::Clone'>Clone</a>, Func: <a class='trait' href='https://doc.rust-lang.org/nightly/core/ops/trait.Fn.html' title='core::ops::Fn'>Fn</a>(I) -> O> <a class='enum' href='../memoization/enum.Memoized.html' title='memoization::Memoized'>Memoized</a><I, O, Func></code></span><span class='out-of-band'><div class='ghost'></div><a id='src-18' class='srclink' href='../src/memoization/src/lib.rs.html#63-171' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.new' class='method'><code>fn <a href='#method.new' class='fnname'>new</a>(lambda: Func) -> <a class='enum' href='../memoization/enum.Memoized.html' title='memoization::Memoized'>Memoized</a><I, O, Func></code></h4>
<div class='docblock'><p>Build a new memoized field. The user will pass a lambda function
that will provide the constructor with typing data.</p>
<pre class='rust rust-example-rendered'>
<span class='kw'>use</span> <span class='ident'>memoization</span>::<span class='ident'>Memoized</span>;
<span class='kw'>let</span> <span class='ident'>lambda</span> <span class='op'>=</span> <span class='op'>|</span> <span class='ident'>a</span>: (<span class='ident'>i32</span>,<span class='ident'>i64</span>,<span class='kw-2'>&</span><span class='ident'>str</span>) <span class='op'>|</span> <span class='op'>-></span> <span class='ident'>String</span> {
<span class='macro'>format</span><span class='macro'>!</span>(<span class='string'>"Line {:?} DateCode {:?} Log \"{}\""</span>,<span class='ident'>a</span>.<span class='number'>0</span>,<span class='ident'>a</span>.<span class='number'>1</span>,<span class='ident'>a</span>.<span class='number'>2</span>)
};
<span class='kw'>let</span> <span class='ident'>memoized</span> <span class='op'>=</span> <span class='ident'>Memoized</span>::<span class='ident'>new</span>(<span class='ident'>lambda</span>);</pre>
</div><h4 id='method.process' class='method'><code>fn <a href='#method.process' class='fnname'>process</a>(&mut self, data: I)</code></h4>
<div class='docblock'><p>This will convert an UnInitialized value to a Processed value. When
called on a processed value it will panic.</p>
<pre class='rust rust-example-rendered'>
<span class='kw'>use</span> <span class='ident'>memoization</span>::<span class='ident'>Memoized</span>;
<span class='kw'>let</span> <span class='ident'>tup</span>: (<span class='ident'>i32</span>,<span class='ident'>i64</span>,<span class='kw-2'>&</span><span class='lifetime'>'static</span> <span class='ident'>str</span>) <span class='op'>=</span> (<span class='number'>20</span>,<span class='op'>-</span><span class='number'>15</span>,<span class='string'>"Hello World!"</span>);
<span class='kw'>let</span> <span class='ident'>lambda</span> <span class='op'>=</span> <span class='op'>|</span> <span class='ident'>a</span>: (<span class='ident'>i32</span>,<span class='ident'>i64</span>,<span class='kw-2'>&</span><span class='ident'>str</span>) <span class='op'>|</span> <span class='op'>-></span> <span class='ident'>String</span> {
<span class='macro'>format</span><span class='macro'>!</span>(<span class='string'>"Line {:?} DateCode {:?} Log \"{}\""</span>,<span class='ident'>a</span>.<span class='number'>0</span>,<span class='ident'>a</span>.<span class='number'>1</span>,<span class='ident'>a</span>.<span class='number'>2</span>)
};
<span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>memoized</span> <span class='op'>=</span> <span class='ident'>Memoized</span>::<span class='ident'>new</span>(<span class='ident'>lambda</span>);
<span class='comment'>//process the data</span>
<span class='ident'>memoized</span>.<span class='ident'>process</span>(<span class='ident'>tup</span>);
<span class='comment'>//borrowing the processed, as it's processed data type</span>
<span class='kw'>let</span> <span class='ident'>x</span>: <span class='kw-2'>&</span><span class='ident'>str</span> <span class='op'>=</span> <span class='kw-2'>&</span><span class='ident'>memoized</span>;
<span class='macro'>assert_eq</span><span class='macro'>!</span>( <span class='ident'>x</span>, <span class='string'>"Line 20 DateCode -15 Log \"Hello World!\""</span>);</pre>
</div><h4 id='method.fetch' class='method'><code>fn <a href='#method.fetch' class='fnname'>fetch</a>(&mut self, data: I) -> O</code></h4>
<div class='docblock'><p>When passed input data the enum will execute, and return a CLONE of its
result. The data will be created at this stage. If the data already
exists it will return a clone of the data.</p>
<pre class='rust rust-example-rendered'>
<span class='kw'>use</span> <span class='ident'>memoization</span>::<span class='ident'>Memoized</span>;
<span class='kw'>let</span> <span class='ident'>tup</span>: (<span class='ident'>i32</span>,<span class='ident'>i64</span>,<span class='kw-2'>&</span><span class='lifetime'>'static</span> <span class='ident'>str</span>) <span class='op'>=</span> (<span class='number'>20</span>,<span class='op'>-</span><span class='number'>15</span>,<span class='string'>"Hello World!"</span>);
<span class='kw'>let</span> <span class='ident'>lambda</span> <span class='op'>=</span> <span class='op'>|</span> <span class='ident'>a</span>: (<span class='ident'>i32</span>,<span class='ident'>i64</span>,<span class='kw-2'>&</span><span class='ident'>str</span>) <span class='op'>|</span> <span class='op'>-></span> <span class='ident'>String</span> {
<span class='macro'>format</span><span class='macro'>!</span>(<span class='string'>"Line {:?} DateCode {:?} Log \"{}\""</span>,<span class='ident'>a</span>.<span class='number'>0</span>,<span class='ident'>a</span>.<span class='number'>1</span>,<span class='ident'>a</span>.<span class='number'>2</span>)
};
<span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>memoized</span> <span class='op'>=</span> <span class='ident'>Memoized</span>::<span class='ident'>new</span>(<span class='ident'>lambda</span>);
<span class='comment'>//process + fetch a copy</span>
<span class='kw'>let</span> <span class='ident'>output</span>: <span class='ident'>String</span> <span class='op'>=</span> <span class='ident'>memoized</span>.<span class='ident'>fetch</span>(<span class='ident'>tup</span>);
<span class='macro'>assert_eq</span><span class='macro'>!</span>( <span class='ident'>output</span>, <span class='string'>"Line 20 DateCode -15 Log \"Hello World!\""</span>.<span class='ident'>to_string</span>());</pre>
</div><h4 id='method.get' class='method'><code>fn <a href='#method.get' class='fnname'>get</a>(&self) -> O</code></h4>
<div class='docblock'><p>returns a clone of a processed field. If the field is not processed the
function will panic.</p>
<pre class='rust rust-example-rendered'>
<span class='kw'>use</span> <span class='ident'>memoization</span>::<span class='ident'>Memoized</span>;
<span class='kw'>let</span> <span class='ident'>tup</span>: (<span class='ident'>i32</span>,<span class='ident'>i64</span>,<span class='kw-2'>&</span><span class='lifetime'>'static</span> <span class='ident'>str</span>) <span class='op'>=</span> (<span class='number'>20</span>,<span class='op'>-</span><span class='number'>15</span>,<span class='string'>"Hello World!"</span>);
<span class='kw'>let</span> <span class='ident'>lambda</span> <span class='op'>=</span> <span class='op'>|</span> <span class='ident'>a</span>: (<span class='ident'>i32</span>,<span class='ident'>i64</span>,<span class='kw-2'>&</span><span class='ident'>str</span>) <span class='op'>|</span> <span class='op'>-></span> <span class='ident'>String</span> {
<span class='macro'>format</span><span class='macro'>!</span>(<span class='string'>"Line {:?} DateCode {:?} Log \"{}\""</span>,<span class='ident'>a</span>.<span class='number'>0</span>,<span class='ident'>a</span>.<span class='number'>1</span>,<span class='ident'>a</span>.<span class='number'>2</span>)
};
<span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>memoized</span> <span class='op'>=</span> <span class='ident'>Memoized</span>::<span class='ident'>new</span>(<span class='ident'>lambda</span>);
<span class='comment'>//process the data</span>
<span class='ident'>memoized</span>.<span class='ident'>process</span>(<span class='ident'>tup</span>);
<span class='comment'>//get copy of the data</span>
<span class='kw'>let</span> <span class='ident'>x</span>: <span class='ident'>String</span> <span class='op'>=</span> <span class='ident'>memoized</span>.<span class='ident'>get</span>();
<span class='macro'>assert_eq</span><span class='macro'>!</span>( <span class='ident'>x</span>, <span class='string'>"Line 20 DateCode -15 Log \"Hello World!\""</span>.<span class='ident'>to_string</span>());</pre>
</div><h4 id='method.is_initialized' class='method'><code>fn <a href='#method.is_initialized' class='fnname'>is_initialized</a>(&self) -> <a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.bool.html'>bool</a></code></h4>
<div class='docblock'><p>Informs user if filed has been processed/initalized.</p>
<pre class='rust rust-example-rendered'>
<span class='kw'>use</span> <span class='ident'>memoization</span>::<span class='ident'>Memoized</span>;
<span class='kw'>let</span> <span class='ident'>tup</span>: (<span class='ident'>i32</span>,<span class='ident'>i64</span>,<span class='kw-2'>&</span><span class='lifetime'>'static</span> <span class='ident'>str</span>) <span class='op'>=</span> (<span class='number'>20</span>,<span class='op'>-</span><span class='number'>15</span>,<span class='string'>"Hello World!"</span>);
<span class='kw'>let</span> <span class='ident'>lambda</span> <span class='op'>=</span> <span class='op'>|</span> <span class='ident'>a</span>: (<span class='ident'>i32</span>,<span class='ident'>i64</span>,<span class='kw-2'>&</span><span class='ident'>str</span>) <span class='op'>|</span> <span class='op'>-></span> <span class='ident'>String</span> {
<span class='macro'>format</span><span class='macro'>!</span>(<span class='string'>"Line {:?} DateCode {:?} Log \"{}\""</span>,<span class='ident'>a</span>.<span class='number'>0</span>,<span class='ident'>a</span>.<span class='number'>1</span>,<span class='ident'>a</span>.<span class='number'>2</span>)
};
<span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>memoized</span> <span class='op'>=</span> <span class='ident'>Memoized</span>::<span class='ident'>new</span>(<span class='ident'>lambda</span>);
<span class='comment'>//data is not initalized/processed</span>
<span class='macro'>assert</span><span class='macro'>!</span>( <span class='op'>!</span> <span class='ident'>memoized</span>.<span class='ident'>is_initialized</span>() );
<span class='comment'>//process the data</span>
<span class='ident'>memoized</span>.<span class='ident'>process</span>(<span class='ident'>tup</span>);
<span class='comment'>//data is now initalized</span>
<span class='macro'>assert</span><span class='macro'>!</span>( <span class='ident'>memoized</span>.<span class='ident'>is_initialized</span>() );</pre>
</div></div><h2 id='implementations'>Trait Implementations</h2><h3 class='impl'><span class='in-band'><code>impl<I: 'static, O: <a class='trait' href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html' title='core::clone::Clone'>Clone</a>, Func: <a class='trait' href='https://doc.rust-lang.org/nightly/core/ops/trait.Fn.html' title='core::ops::Fn'>Fn</a>(I) -> O> <a class='trait' href='https://doc.rust-lang.org/nightly/core/ops/trait.Deref.html' title='core::ops::Deref'>Deref</a> for <a class='enum' href='../memoization/enum.Memoized.html' title='memoization::Memoized'>Memoized</a><I, O, Func></code></span><span class='out-of-band'><div class='ghost'></div><a id='src-43' class='srclink' href='../src/memoization/src/lib.rs.html#172-180' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='associatedtype.Target' class='type'><code>type <a href='https://doc.rust-lang.org/nightly/core/ops/trait.Deref.html#associatedtype.Target' class='type'>Target</a> = O</code></h4>
<div class='docblock'><p>The resulting type after dereferencing</p>
</div><h4 id='method.deref' class='method'><code>fn <a href='https://doc.rust-lang.org/nightly/core/ops/trait.Deref.html#tymethod.deref' class='fnname'>deref</a><'b>(&'b self) -> &'b Self::Target</code></h4>
<div class='docblock'><p>The method called to dereference a value</p>
</div></div><h3 class='impl'><span class='in-band'><code>impl<I: 'static, O: <a class='trait' href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html' title='core::clone::Clone'>Clone</a>, Func: <a class='trait' href='https://doc.rust-lang.org/nightly/core/ops/trait.Fn.html' title='core::ops::Fn'>Fn</a>(I) -> O> <a class='trait' href='https://doc.rust-lang.org/nightly/core/ops/trait.DerefMut.html' title='core::ops::DerefMut'>DerefMut</a> for <a class='enum' href='../memoization/enum.Memoized.html' title='memoization::Memoized'>Memoized</a><I, O, Func></code></span><span class='out-of-band'><div class='ghost'></div><a id='src-53' class='srclink' href='../src/memoization/src/lib.rs.html#181-196' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.deref_mut' class='method'><code>fn <a href='https://doc.rust-lang.org/nightly/core/ops/trait.DerefMut.html#tymethod.deref_mut' class='fnname'>deref_mut</a><'b>(&'b mut self) -> &'b mut Self::Target</code></h4>
<div class='docblock'><p>The method called to mutably dereference a value</p>
</div></div><h3 class='impl'><span class='in-band'><code>impl<I: 'static, O: <a class='trait' href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html' title='core::clone::Clone'>Clone</a>, Func: <a class='trait' href='https://doc.rust-lang.org/nightly/core/ops/trait.Fn.html' title='core::ops::Fn'>Fn</a>(I) -> O> <a class='trait' href='https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html' title='core::borrow::Borrow'>Borrow</a><O> for <a class='enum' href='../memoization/enum.Memoized.html' title='memoization::Memoized'>Memoized</a><I, O, Func></code></span><span class='out-of-band'><div class='ghost'></div><a id='src-64' class='srclink' href='../src/memoization/src/lib.rs.html#197-204' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.borrow' class='method'><code>fn <a href='https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow' class='fnname'>borrow</a><'b>(&'b self) -> &'b O</code></h4>
<div class='docblock'><p>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></p>
</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>?</dt>
<dd>Show this help dialog</dd>
<dt>S</dt>
<dd>Focus the search field</dd>
<dt>⇤</dt>
<dd>Move up in search results</dd>
<dt>⇥</dt>
<dd>Move down in search results</dd>
<dt>⏎</dt>
<dd>Go to active search result</dd>
<dt>+</dt>
<dd>Collapse/expand 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 = "memoization";
window.playgroundUrl = "";
</script>
<script src="../jquery.js"></script>
<script src="../main.js"></script>
<script defer src="../search-index.js"></script>
</body>
</html>