139 lines
No EOL
6.3 KiB
HTML
139 lines
No EOL
6.3 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 `plugin`.">
|
||
<meta name="keywords" content="rust, rustlang, rust-lang, Plugin">
|
||
|
||
<title>plugin::Plugin - 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'>plugin</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'>plugin</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-7' class='srclink' href='../src/plugin/lib.rs.html#14-25' title='goto source code'>[src]</a></span></h1>
|
||
<pre class='rust trait'>pub trait Plugin<E: ?<a class='trait' href='https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html' title='core::marker::Sized'>Sized</a>>: <a class='trait' href='../typemap/trait.Key.html' title='typemap::Key'>Key</a> {
|
||
type <a href='#associatedtype.Error' class='type'>Error</a>;
|
||
fn <a href='#tymethod.eval' class='fnname'>eval</a>(&mut E) -> <a class='enum' href='https://doc.rust-lang.org/nightly/core/result/enum.Result.html' title='core::result::Result'>Result</a><Self::<a class='trait' href='../plugin/trait.Plugin.html' title='plugin::Plugin'>Value</a>, Self::<a class='trait' href='../plugin/trait.Plugin.html' title='plugin::Plugin'>Error</a>>;
|
||
}</pre><div class='docblock'><p>Implementers of this trait can act as plugins for other types, via <code>OtherType::get<P>()</code>.</p>
|
||
|
||
<p>To create a plugin, implement this trait and provide an empty implementation
|
||
of <code>Key</code> to associate the plugin with its return type, <code>Key::Value</code>.</p>
|
||
</div>
|
||
<h2 id='associated-types'>Associated Types</h2>
|
||
<div class='methods'>
|
||
<h3 id='associatedtype.Error' class='method stab '><code>type <a href='#associatedtype.Error' class='type'>Error</a></code></h3><div class='docblock'><p>The error type associated with this plugin.</p>
|
||
</div></div>
|
||
<h2 id='required-methods'>Required Methods</h2>
|
||
<div class='methods'>
|
||
<h3 id='tymethod.eval' class='method stab '><code>fn <a href='#tymethod.eval' class='fnname'>eval</a>(&mut E) -> <a class='enum' href='https://doc.rust-lang.org/nightly/core/result/enum.Result.html' title='core::result::Result'>Result</a><Self::<a class='trait' href='../plugin/trait.Plugin.html' title='plugin::Plugin'>Value</a>, Self::<a class='trait' href='../plugin/trait.Plugin.html' title='plugin::Plugin'>Error</a>></code></h3><div class='docblock'><p>Create the plugin from an instance of the extended type.</p>
|
||
|
||
<p>While <code>eval</code> is given a mutable reference to the extended
|
||
type, it is important for implementers to remember that
|
||
the result of <code>eval</code> is usually cached, so care should
|
||
be taken when doing mutation on the extended type.</p>
|
||
</div></div>
|
||
<h2 id='implementors'>Implementors</h2>
|
||
<ul class='item-list' id='implementors-list'>
|
||
</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 = "plugin";
|
||
window.playgroundUrl = "";
|
||
</script>
|
||
<script src="../jquery.js"></script>
|
||
<script src="../main.js"></script>
|
||
|
||
<script defer src="../search-index.js"></script>
|
||
</body>
|
||
</html> |