151 lines
12 KiB
HTML
151 lines
12 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 `Plugin` trait in crate `iron`.">
|
|||
|
|
<meta name="keywords" content="rust, rustlang, rust-lang, Plugin">
|
|||
|
|
|
|||
|
|
<title>iron::Plugin - Rust</title>
|
|||
|
|
|
|||
|
|
<link rel="stylesheet" type="text/css" href="../rustdoc.css">
|
|||
|
|
<link rel="stylesheet" type="text/css" href="../main.css">
|
|||
|
|
|
|||
|
|
|
|||
|
|
<link rel="shortcut icon" href="https://avatars0.githubusercontent.com/u/7853871?s=256">
|
|||
|
|
|
|||
|
|
</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">
|
|||
|
|
<a href='../iron/index.html'><img src='https://avatars0.githubusercontent.com/u/7853871?s=128' alt='logo' width='100'></a>
|
|||
|
|
<p class='location'><a href='index.html'>iron</a></p><script>window.sidebarCurrent = {name: 'Plugin', ty: 'trait', 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 trait">
|
|||
|
|
<h1 class='fqn'><span class='in-band'>Trait <a href='index.html'>iron</a>::<wbr><a class='trait' href=''>Plugin</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-17' class='srclink' href='../plugin/trait.Pluggable.html?gotosrc=17' title='goto source code'>[src]</a></span></h1>
|
|||
|
|
<pre class='rust trait'>pub trait Plugin {
|
|||
|
|
fn <a href='#method.get' class='fnname'>get</a><P>(&mut self) -> <a class='enum' href='https://doc.rust-lang.org/nightly/core/result/enum.Result.html' title='core::result::Result'>Result</a><P::<a class='trait' href='../iron/typemap/trait.Key.html' title='iron::typemap::Key'>Value</a>, P::<a class='trait' href='../plugin/trait.Plugin.html' title='plugin::Plugin'>Error</a>> <span class='where'>where P: <a class='trait' href='../plugin/trait.Plugin.html' title='plugin::Plugin'>Plugin</a><Self>, Self: <a class='trait' href='../plugin/trait.Extensible.html' title='plugin::Extensible'>Extensible</a>, P::<a class='trait' href='../iron/typemap/trait.Key.html' title='iron::typemap::Key'>Value</a>: <a class='trait' href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html' title='core::clone::Clone'>Clone</a>, P::<a class='trait' href='../iron/typemap/trait.Key.html' title='iron::typemap::Key'>Value</a>: <a class='trait' href='https://doc.rust-lang.org/nightly/core/any/trait.Any.html' title='core::any::Any'>Any</a></span> { ... }
|
|||
|
|
fn <a href='#method.get_ref' class='fnname'>get_ref</a><P>(&mut self) -> <a class='enum' href='https://doc.rust-lang.org/nightly/core/result/enum.Result.html' title='core::result::Result'>Result</a><&P::<a class='trait' href='../iron/typemap/trait.Key.html' title='iron::typemap::Key'>Value</a>, P::<a class='trait' href='../plugin/trait.Plugin.html' title='plugin::Plugin'>Error</a>> <span class='where'>where P: <a class='trait' href='../plugin/trait.Plugin.html' title='plugin::Plugin'>Plugin</a><Self>, Self: <a class='trait' href='../plugin/trait.Extensible.html' title='plugin::Extensible'>Extensible</a>, P::<a class='trait' href='../iron/typemap/trait.Key.html' title='iron::typemap::Key'>Value</a>: <a class='trait' href='https://doc.rust-lang.org/nightly/core/any/trait.Any.html' title='core::any::Any'>Any</a></span> { ... }
|
|||
|
|
fn <a href='#method.get_mut' class='fnname'>get_mut</a><P>(&mut self) -> <a class='enum' href='https://doc.rust-lang.org/nightly/core/result/enum.Result.html' title='core::result::Result'>Result</a><&mut P::<a class='trait' href='../iron/typemap/trait.Key.html' title='iron::typemap::Key'>Value</a>, P::<a class='trait' href='../plugin/trait.Plugin.html' title='plugin::Plugin'>Error</a>> <span class='where'>where P: <a class='trait' href='../plugin/trait.Plugin.html' title='plugin::Plugin'>Plugin</a><Self>, Self: <a class='trait' href='../plugin/trait.Extensible.html' title='plugin::Extensible'>Extensible</a>, P::<a class='trait' href='../iron/typemap/trait.Key.html' title='iron::typemap::Key'>Value</a>: <a class='trait' href='https://doc.rust-lang.org/nightly/core/any/trait.Any.html' title='core::any::Any'>Any</a></span> { ... }
|
|||
|
|
fn <a href='#method.compute' class='fnname'>compute</a><P>(&mut self) -> <a class='enum' href='https://doc.rust-lang.org/nightly/core/result/enum.Result.html' title='core::result::Result'>Result</a><P::<a class='trait' href='../iron/typemap/trait.Key.html' title='iron::typemap::Key'>Value</a>, P::<a class='trait' href='../plugin/trait.Plugin.html' title='plugin::Plugin'>Error</a>> <span class='where'>where P: <a class='trait' href='../plugin/trait.Plugin.html' title='plugin::Plugin'>Plugin</a><Self></span> { ... }
|
|||
|
|
}</pre><div class='docblock'><p>An interface for plugins that cache values between calls.</p>
|
|||
|
|
|
|||
|
|
<p><code>R</code> is the type of the plugin's return value, which must be cloneable.</p>
|
|||
|
|
</div>
|
|||
|
|
<h2 id='provided-methods'>Provided Methods</h2>
|
|||
|
|
<div class='methods'>
|
|||
|
|
<h3 id='method.get' class='method stab '><code>fn <a href='#method.get' class='fnname'>get</a><P>(&mut self) -> <a class='enum' href='https://doc.rust-lang.org/nightly/core/result/enum.Result.html' title='core::result::Result'>Result</a><P::<a class='trait' href='../iron/typemap/trait.Key.html' title='iron::typemap::Key'>Value</a>, P::<a class='trait' href='../plugin/trait.Plugin.html' title='plugin::Plugin'>Error</a>> <span class='where'>where P: <a class='trait' href='../plugin/trait.Plugin.html' title='plugin::Plugin'>Plugin</a><Self>, Self: <a class='trait' href='../plugin/trait.Extensible.html' title='plugin::Extensible'>Extensible</a>, P::<a class='trait' href='../iron/typemap/trait.Key.html' title='iron::typemap::Key'>Value</a>: <a class='trait' href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html' title='core::clone::Clone'>Clone</a>, P::<a class='trait' href='../iron/typemap/trait.Key.html' title='iron::typemap::Key'>Value</a>: <a class='trait' href='https://doc.rust-lang.org/nightly/core/any/trait.Any.html' title='core::any::Any'>Any</a></span></code></h3><div class='docblock'><p>Return a copy of the plugin's produced value.</p>
|
|||
|
|
|
|||
|
|
<p>The plugin will be created if it doesn't exist already.
|
|||
|
|
If plugin creation fails, an error is returned.</p>
|
|||
|
|
|
|||
|
|
<p><code>P</code> is the plugin type.</p>
|
|||
|
|
</div><h3 id='method.get_ref' class='method stab '><code>fn <a href='#method.get_ref' class='fnname'>get_ref</a><P>(&mut self) -> <a class='enum' href='https://doc.rust-lang.org/nightly/core/result/enum.Result.html' title='core::result::Result'>Result</a><&P::<a class='trait' href='../iron/typemap/trait.Key.html' title='iron::typemap::Key'>Value</a>, P::<a class='trait' href='../plugin/trait.Plugin.html' title='plugin::Plugin'>Error</a>> <span class='where'>where P: <a class='trait' href='../plugin/trait.Plugin.html' title='plugin::Plugin'>Plugin</a><Self>, Self: <a class='trait' href='../plugin/trait.Extensible.html' title='plugin::Extensible'>Extensible</a>, P::<a class='trait' href='../iron/typemap/trait.Key.html' title='iron::typemap::Key'>Value</a>: <a class='trait' href='https://doc.rust-lang.org/nightly/core/any/trait.Any.html' title='core::any::Any'>Any</a></span></code></h3><div class='docblock'><p>Return a reference to the plugin's produced value.</p>
|
|||
|
|
|
|||
|
|
<p>The plugin will be created if it doesn't exist already.
|
|||
|
|
If plugin creation fails an error is returned.</p>
|
|||
|
|
|
|||
|
|
<p><code>P</code> is the plugin type.</p>
|
|||
|
|
</div><h3 id='method.get_mut' class='method stab '><code>fn <a href='#method.get_mut' class='fnname'>get_mut</a><P>(&mut self) -> <a class='enum' href='https://doc.rust-lang.org/nightly/core/result/enum.Result.html' title='core::result::Result'>Result</a><&mut P::<a class='trait' href='../iron/typemap/trait.Key.html' title='iron::typemap::Key'>Value</a>, P::<a class='trait' href='../plugin/trait.Plugin.html' title='plugin::Plugin'>Error</a>> <span class='where'>where P: <a class='trait' href='../plugin/trait.Plugin.html' title='plugin::Plugin'>Plugin</a><Self>, Self: <a class='trait' href='../plugin/trait.Extensible.html' title='plugin::Extensible'>Extensible</a>, P::<a class='trait' href='../iron/typemap/trait.Key.html' title='iron::typemap::Key'>Value</a>: <a class='trait' href='https://doc.rust-lang.org/nightly/core/any/trait.Any.html' title='core::any::Any'>Any</a></span></code></h3><div class='docblock'><p>Return a mutable reference to the plugin's produced value.</p>
|
|||
|
|
|
|||
|
|
<p>The plugin will be created if it doesn't exist already.
|
|||
|
|
If plugin creation fail an error is returned.</p>
|
|||
|
|
|
|||
|
|
<p><code>P</code> is the plugin type.</p>
|
|||
|
|
</div><h3 id='method.compute' class='method stab '><code>fn <a href='#method.compute' class='fnname'>compute</a><P>(&mut self) -> <a class='enum' href='https://doc.rust-lang.org/nightly/core/result/enum.Result.html' title='core::result::Result'>Result</a><P::<a class='trait' href='../iron/typemap/trait.Key.html' title='iron::typemap::Key'>Value</a>, P::<a class='trait' href='../plugin/trait.Plugin.html' title='plugin::Plugin'>Error</a>> <span class='where'>where P: <a class='trait' href='../plugin/trait.Plugin.html' title='plugin::Plugin'>Plugin</a><Self></span></code></h3><div class='docblock'><p>Create and evaluate a once-off instance of a plugin.</p>
|
|||
|
|
</div></div>
|
|||
|
|
<h2 id='implementors'>Implementors</h2>
|
|||
|
|
<ul class='item-list' id='implementors-list'>
|
|||
|
|
<li><code>impl Plugin for <a class='struct' href='../iron/response/struct.Response.html' title='iron::response::Response'>Response</a></code></li>
|
|||
|
|
<li><code>impl<'a, 'b> Plugin for <a class='struct' href='../iron/request/struct.Request.html' title='iron::request::Request'>Request</a><'a, 'b></code></li>
|
|||
|
|
</ul><script type="text/javascript" async
|
|||
|
|
src="../implementors/plugin/trait.Plugin.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>?</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 = "iron";
|
|||
|
|
window.playgroundUrl = "";
|
|||
|
|
</script>
|
|||
|
|
<script src="../jquery.js"></script>
|
|||
|
|
<script src="../main.js"></script>
|
|||
|
|
|
|||
|
|
<script defer src="../search-index.js"></script>
|
|||
|
|
</body>
|
|||
|
|
</html>
|