mirror of
https://github.com/neogeek23/rusty_snek_gaem.git
synced 2026-02-04 11:08:40 +00:00
48 lines
23 KiB
HTML
48 lines
23 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 `Symbol` struct in crate `dlib`."><meta name="keywords" content="rust, rustlang, rust-lang, Symbol"><title>dlib::Symbol - 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 Symbol</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.into_raw">into_raw</a><a href="#method.from_raw">from_raw</a><a href="#method.lift_option">lift_option</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-Sync">Sync</a><a href="#impl-Deref">Deref</a><a href="#impl-Send">Send</a></div></div><p class='location'><a href='index.html'>dlib</a></p><script>window.sidebarCurrent = {name: 'Symbol', 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"><a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='in-band'>Struct <a href='index.html'>dlib</a>::<wbr><a class="struct" href=''>Symbol</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/libloading/lib.rs.html#209-212' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust struct'>pub struct Symbol<'lib, T> <span class="where fmt-newline">where<br> T: 'lib, </span> { /* fields omitted */ }</pre></div><div class='docblock'><p>Symbol from a library.</p>
|
|||
|
|
<p>This type is a safeguard against using dynamically loaded symbols after a <code>Library</code> is
|
|||
|
|
unloaded. Primary method to create an instance of a <code>Symbol</code> is via <code>Library::get</code>.</p>
|
|||
|
|
<p>Due to implementation of the <code>Deref</code> trait, an instance of <code>Symbol</code> may be used as if it was a
|
|||
|
|
function or variable directly, without taking care to “extract” function or variable manually
|
|||
|
|
most of the time.</p>
|
|||
|
|
<p>See <a href="./struct.Library.html#method.get"><code>Library::get</code></a> for details.</p>
|
|||
|
|
</div><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<'lib, T> <a class="struct" href="../dlib/struct.Symbol.html" title="struct dlib::Symbol">Symbol</a><'lib, T></code><a href='#impl' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/libloading/lib.rs.html#214-263' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.into_raw' class="method"><span id='into_raw.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub unsafe fn <a href='#method.into_raw' class='fnname'>into_raw</a>(self) -> <a class="struct" href="../libloading/os/unix/struct.Symbol.html" title="struct libloading::os::unix::Symbol">Symbol</a><T></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/libloading/lib.rs.html#232-234' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Extract the wrapped <code>os::platform::Symbol</code>.</p>
|
|||
|
|
<h2 id="unsafety" class="section-header"><a href="#unsafety">Unsafety</a></h2>
|
|||
|
|
<p>Using this function relinquishes all the lifetime guarantees. It is up to programmer to
|
|||
|
|
ensure the resulting <code>Symbol</code> is not used past the lifetime of the <code>Library</code> this symbol
|
|||
|
|
was loaded from.</p>
|
|||
|
|
<h2 id="examples" class="section-header"><a href="#examples">Examples</a></h2>
|
|||
|
|
<pre class="rust rust-example-rendered">
|
|||
|
|
<span class="kw">let</span> <span class="ident">lib</span> <span class="op">=</span> <span class="ident">Library</span>::<span class="ident">new</span>(<span class="string">"/path/to/awesome.module"</span>).<span class="ident">unwrap</span>();
|
|||
|
|
<span class="kw">unsafe</span> {
|
|||
|
|
<span class="kw">let</span> <span class="ident">symbol</span>: <span class="ident">Symbol</span><span class="op"><</span><span class="kw-2">*</span><span class="kw-2">mut</span> <span class="ident">u32</span><span class="op">></span> <span class="op">=</span> <span class="ident">lib</span>.<span class="ident">get</span>(<span class="string">b"symbol\0"</span>).<span class="ident">unwrap</span>();
|
|||
|
|
<span class="kw">let</span> <span class="ident">symbol</span> <span class="op">=</span> <span class="ident">symbol</span>.<span class="ident">into_raw</span>();
|
|||
|
|
}</pre>
|
|||
|
|
</div><h4 id='method.from_raw' class="method"><span id='from_raw.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub unsafe fn <a href='#method.from_raw' class='fnname'>from_raw</a><L>(sym: <a class="struct" href="../libloading/os/unix/struct.Symbol.html" title="struct libloading::os::unix::Symbol">Symbol</a><T>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'lib </a>L) -> <a class="struct" href="../dlib/struct.Symbol.html" title="struct dlib::Symbol">Symbol</a><'lib, T></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/libloading/lib.rs.html#257-262' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Wrap the <code>os::platform::Symbol</code> into this safe wrapper.</p>
|
|||
|
|
<p>Note that, in order to create association between the symbol and the library this symbol
|
|||
|
|
came from, this function requires reference to the library provided.</p>
|
|||
|
|
<h2 id="unsafety-1" class="section-header"><a href="#unsafety-1">Unsafety</a></h2>
|
|||
|
|
<p>It is invalid to provide a reference to any other value other than the library the <code>sym</code>
|
|||
|
|
was loaded from. Doing so invalidates any lifetime guarantees.</p>
|
|||
|
|
<h2 id="examples-1" class="section-header"><a href="#examples-1">Examples</a></h2>
|
|||
|
|
<pre class="rust rust-example-rendered">
|
|||
|
|
<span class="kw">let</span> <span class="ident">lib</span> <span class="op">=</span> <span class="ident">Library</span>::<span class="ident">new</span>(<span class="string">"/path/to/awesome.module"</span>).<span class="ident">unwrap</span>();
|
|||
|
|
<span class="kw">unsafe</span> {
|
|||
|
|
<span class="kw">let</span> <span class="ident">symbol</span>: <span class="ident">Symbol</span><span class="op"><</span><span class="kw-2">*</span><span class="kw-2">mut</span> <span class="ident">u32</span><span class="op">></span> <span class="op">=</span> <span class="ident">lib</span>.<span class="ident">get</span>(<span class="string">b"symbol\0"</span>).<span class="ident">unwrap</span>();
|
|||
|
|
<span class="kw">let</span> <span class="ident">symbol</span> <span class="op">=</span> <span class="ident">symbol</span>.<span class="ident">into_raw</span>();
|
|||
|
|
<span class="kw">let</span> <span class="ident">symbol</span> <span class="op">=</span> <span class="ident">Symbol</span>::<span class="ident">from_raw</span>(<span class="ident">symbol</span>, <span class="kw-2">&</span><span class="ident">lib</span>);
|
|||
|
|
}</pre>
|
|||
|
|
</div></div><h3 id='impl-1' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<'lib, T> <a class="struct" href="../dlib/struct.Symbol.html" title="struct dlib::Symbol">Symbol</a><'lib, <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><T>></code><a href='#impl-1' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/libloading/lib.rs.html#265-284' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.lift_option' class="method"><span id='lift_option.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.lift_option' class='fnname'>lift_option</a>(self) -> <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="../dlib/struct.Symbol.html" title="struct dlib::Symbol">Symbol</a><'lib, T>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/libloading/lib.rs.html#278-283' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Lift Option out of the symbol.</p>
|
|||
|
|
<h2 id="examples-2" class="section-header"><a href="#examples-2">Examples</a></h2>
|
|||
|
|
<pre class="rust rust-example-rendered">
|
|||
|
|
<span class="kw">let</span> <span class="ident">lib</span> <span class="op">=</span> <span class="ident">Library</span>::<span class="ident">new</span>(<span class="string">"/path/to/awesome.module"</span>).<span class="ident">unwrap</span>();
|
|||
|
|
<span class="kw">unsafe</span> {
|
|||
|
|
<span class="kw">let</span> <span class="ident">symbol</span>: <span class="ident">Symbol</span><span class="op"><</span><span class="prelude-ty">Option</span><span class="op"><</span><span class="kw-2">*</span><span class="kw-2">mut</span> <span class="ident">u32</span><span class="op">>></span> <span class="op">=</span> <span class="ident">lib</span>.<span class="ident">get</span>(<span class="string">b"symbol\0"</span>).<span class="ident">unwrap</span>();
|
|||
|
|
<span class="kw">let</span> <span class="ident">symbol</span>: <span class="ident">Symbol</span><span class="op"><</span><span class="kw-2">*</span><span class="kw-2">mut</span> <span class="ident">u32</span><span class="op">></span> <span class="op">=</span> <span class="ident">symbol</span>.<span class="ident">lift_option</span>().<span class="ident">expect</span>(<span class="string">"static is not null"</span>);
|
|||
|
|
}</pre>
|
|||
|
|
</div></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<'lib, T> <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="../dlib/struct.Symbol.html" title="struct dlib::Symbol">Symbol</a><'lib, T></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/libloading/lib.rs.html#286-293' 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="../dlib/struct.Symbol.html" title="struct dlib::Symbol">Symbol</a><'lib, T></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/libloading/lib.rs.html#287-292' 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#130-132' 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<'lib, T> <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="../dlib/struct.Symbol.html" title="struct dlib::Symbol">Symbol</a><'lib, T></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/libloading/lib.rs.html#303-307' 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, f: &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="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Error.html" title="struct core::fmt::Error">Error</a>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/libloading/lib.rs.html#304-306' 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-Sync' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<'lib, T> <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="../dlib/struct.Symbol.html" title="struct dlib::Symbol">Symbol</a><'lib, T> <span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>, </span></code><a href='#impl-Sync' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/libloading/lib.rs.html#310' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'></div><h3 id='impl-Deref' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<'lib, T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/deref/trait.Deref.html" title="trait core::ops::deref::Deref">Deref</a> for <a class="struct" href="../dlib/struct.Symbol.html" title="struct dlib::Symbol">Symbol</a><'lib, T></code><a href='#impl-Deref' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/libloading/lib.rs.html#296-301' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='associatedtype.Target' class="type"><span id='Target.t' class='invisible'><code>type <a href='https://doc.rust-lang.org/nightly/core/ops/deref/trait.Deref.html#associatedtype.Target' class="type">Target</a> = T</code></span></h4>
|
|||
|
|
<div class='docblock'><p>The resulting type after dereferencing.</p>
|
|||
|
|
</div><h4 id='method.deref' class="method"><div class="important-traits"><div class='tooltip'>ⓘ<span class='tooltiptext'>Important traits for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>W</span></div><div class="content hidden"><h3 class="important">Important traits for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>W</h3><code class="content"><span class="where fmt-newline">impl<'a, W> <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Write.html" title="trait std::io::Write">Write</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>W <span class="where fmt-newline">where<br> W: <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Write.html" title="trait std::io::Write">Write</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></span><span class="where fmt-newline">impl<'a, R> <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>R <span class="where fmt-newline">where<br> R: <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></span><span class="where fmt-newline">impl<'a, I> <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>I <span class="where fmt-newline">where<br> I: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></span><span class="where fmt-newline"> type <a href='https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html#associatedtype.Item' class="type">Item</a> = <I as <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html#associatedtype.Item" title="type core::iter::iterator::Iterator::Item">Item</a>;</span></code></div></div><span id='deref.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/ops/deref/trait.Deref.html#tymethod.deref' class='fnname'>deref</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>T</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/libloading/lib.rs.html#298-300' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Dereferences the value.</p>
|
|||
|
|
</div></div><h3 id='impl-Send' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<'lib, T> <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="../dlib/struct.Symbol.html" title="struct dlib::Symbol">Symbol</a><'lib, T> <span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>, </span></code><a href='#impl-Send' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/libloading/lib.rs.html#309' title='goto source code'>[src]</a></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><p>Search multiple things at once by splitting your query with comma (e.g. <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../";window.currentCrate = "dlib";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html>
|