mirror of
https://github.com/neogeek23/rusty_snek_gaem.git
synced 2026-02-04 19:18:44 +00:00
79 lines
19 KiB
HTML
79 lines
19 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 `Library` struct in crate `libloading`."><meta name="keywords" content="rust, rustlang, rust-lang, Library"><title>libloading::Library - 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 Library</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.new">new</a><a href="#method.get">get</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Debug">Debug</a><a href="#impl-From%3CLibrary%3E">From<Library></a><a href="#impl-Send">Send</a><a href="#impl-Sync">Sync</a></div></div><p class='location'><a href='index.html'>libloading</a></p><script>window.sidebarCurrent = {name: 'Library', 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'>libloading</a>::<wbr><a class="struct" href=''>Library</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#56' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust struct'>pub struct Library(_);</pre></div><div class='docblock'><p>A loaded dynamic library.</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 <a class="struct" href="../libloading/struct.Library.html" title="struct libloading::Library">Library</a></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#58-174' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.new' class="method"><span id='new.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.new' class='fnname'>new</a><P: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a><<a class="struct" href="https://doc.rust-lang.org/nightly/std/ffi/os_str/struct.OsStr.html" title="struct std::ffi::os_str::OsStr">OsStr</a>>>(filename: P) -> <a class="type" href="../libloading/type.Result.html" title="type libloading::Result">Result</a><<a class="struct" href="../libloading/struct.Library.html" title="struct libloading::Library">Library</a>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/libloading/lib.rs.html#117-119' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Find and load a dynamic library.</p>
|
||
<p>The <code>filename</code> argument may be any of:</p>
|
||
<ul>
|
||
<li>A library filename;</li>
|
||
<li>Absolute path to the library;</li>
|
||
<li>Relative (to the current working directory) path to the library.</li>
|
||
</ul>
|
||
<h2 id="thread-safety" class="section-header"><a href="#thread-safety">Thread-safety</a></h2>
|
||
<p>The implementation strives to be as MT-safe as sanely possible, however due to certain
|
||
error-handling related resources not always being safe, this library is not MT-safe either.</p>
|
||
<ul>
|
||
<li>On Windows Vista and earlier error handling falls back to <a href="https://msdn.microsoft.com/en-us/library/windows/desktop/ms680621(v=vs.85).aspx"><code>SetErrorMode</code></a>, which is not
|
||
MT-safe. MT-scenarios involving this function may cause a traditional data race;</li>
|
||
<li>On some UNIX targets <code>dlerror</code> might not be MT-safe, resulting in garbage error messages
|
||
in certain MT-scenarios.</li>
|
||
</ul>
|
||
<p>Calling this function from multiple threads is not safe if used in conjunction with
|
||
path-less filename and library search path is modified (<code>SetDllDirectory</code> function on
|
||
Windows, <code>{DY,}LD_LIBRARY_PATH</code> environment variable on UNIX).</p>
|
||
<h2 id="platform-specific-behaviour" class="section-header"><a href="#platform-specific-behaviour">Platform-specific behaviour</a></h2>
|
||
<p>When a plain library filename is supplied, locations where library is searched for is
|
||
platform specific and cannot be adjusted in a portable manner.</p>
|
||
<h3 id="windows" class="section-header"><a href="#windows">Windows</a></h3>
|
||
<p>If the <code>filename</code> specifies a library filename without path and with extension omitted,
|
||
<code>.dll</code> extension is implicitly added. This behaviour may be suppressed by appending a
|
||
trailing <code>.</code> to the <code>filename</code>.</p>
|
||
<p>If the library contains thread local variables (MSVC’s <code>_declspec(thread)</code>, Rust’s
|
||
<code>#[thread_local]</code> attributes), loading the library will fail on versions prior to Windows
|
||
Vista.</p>
|
||
<h2 id="tips" class="section-header"><a href="#tips">Tips</a></h2>
|
||
<p>Distributing your dynamic libraries under a filename common to all platforms (e.g.
|
||
<code>awesome.module</code>) allows to avoid code which has to account for platform’s conventional
|
||
library filenames.</p>
|
||
<p>Strive to specify absolute or relative path to your library, unless system-wide libraries
|
||
are being loaded. Platform-dependent library search locations combined with various quirks
|
||
related to path-less filenames may cause flaky code.</p>
|
||
<h2 id="examples" class="section-header"><a href="#examples">Examples</a></h2>
|
||
<pre class="rust rust-example-rendered">
|
||
<span class="comment">// Any of the following are valid.</span>
|
||
<span class="kw">let</span> <span class="kw">_</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">let</span> <span class="kw">_</span> <span class="op">=</span> <span class="ident">Library</span>::<span class="ident">new</span>(<span class="string">"../awesome.module"</span>).<span class="ident">unwrap</span>();
|
||
<span class="kw">let</span> <span class="kw">_</span> <span class="op">=</span> <span class="ident">Library</span>::<span class="ident">new</span>(<span class="string">"libsomelib.so.1"</span>).<span class="ident">unwrap</span>();</pre>
|
||
</div><h4 id='method.get' class="method"><span id='get.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub unsafe fn <a href='#method.get' class='fnname'>get</a><'lib, T>(&'lib self, symbol: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>) -> <a class="type" href="../libloading/type.Result.html" title="type libloading::Result">Result</a><<a class="struct" href="../libloading/struct.Symbol.html" title="struct libloading::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#171-173' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Get a pointer to function or static variable by symbol name.</p>
|
||
<p>The <code>symbol</code> may not contain any null bytes, with an exception of last byte. A null
|
||
terminated <code>symbol</code> may avoid a string allocation in some cases.</p>
|
||
<p>Symbol is interpreted as-is; no mangling is done. This means that symbols like <code>x::y</code> are
|
||
most likely invalid.</p>
|
||
<h2 id="unsafety" class="section-header"><a href="#unsafety">Unsafety</a></h2>
|
||
<p>Pointer to a value of arbitrary type is returned. Using a value with wrong type is
|
||
undefined.</p>
|
||
<h2 id="platform-specific-behaviour-1" class="section-header"><a href="#platform-specific-behaviour-1">Platform-specific behaviour</a></h2>
|
||
<p>On Linux and Windows, a TLS variable acts just like any regular static variable. OS X uses
|
||
some sort of lazy initialization scheme, which makes loading TLS variables this way
|
||
impossible. Using a TLS variable loaded this way on OS X is undefined behaviour.</p>
|
||
<h2 id="examples-1" class="section-header"><a href="#examples-1">Examples</a></h2>
|
||
<p>Given a loaded library:</p>
|
||
|
||
<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>();</pre>
|
||
<p>Loading and using a function looks like this:</p>
|
||
|
||
<pre class="rust rust-example-rendered">
|
||
<span class="kw">unsafe</span> {
|
||
<span class="kw">let</span> <span class="ident">awesome_function</span>: <span class="ident">Symbol</span><span class="op"><</span><span class="kw">unsafe</span> <span class="kw">extern</span> <span class="kw">fn</span>(<span class="ident">f64</span>) <span class="op">-></span> <span class="ident">f64</span><span class="op">></span> <span class="op">=</span>
|
||
<span class="ident">lib</span>.<span class="ident">get</span>(<span class="string">b"awesome_function\0"</span>).<span class="ident">unwrap</span>();
|
||
<span class="ident">awesome_function</span>(<span class="number">0.42</span>);
|
||
}</pre>
|
||
<p>A static variable may also be loaded and inspected:</p>
|
||
|
||
<pre class="rust rust-example-rendered">
|
||
<span class="kw">unsafe</span> {
|
||
<span class="kw">let</span> <span class="ident">awesome_variable</span>: <span class="ident">Symbol</span><span class="op"><</span><span class="kw-2">*</span><span class="kw-2">mut</span> <span class="ident">f64</span><span class="op">></span> <span class="op">=</span> <span class="ident">lib</span>.<span class="ident">get</span>(<span class="string">b"awesome_variable\0"</span>).<span class="ident">unwrap</span>();
|
||
<span class="kw-2">*</span><span class="kw-2">*</span><span class="ident">awesome_variable</span> <span class="op">=</span> <span class="number">42.0</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-Debug' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <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="../libloading/struct.Library.html" title="struct libloading::Library">Library</a></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#176-180' 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="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/libloading/lib.rs.html#177-179' 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-From%3CLibrary%3E' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><<a class="struct" href="../libloading/os/unix/struct.Library.html" title="struct libloading::os::unix::Library">Library</a>> for <a class="struct" href="../libloading/struct.Library.html" title="struct libloading::Library">Library</a></code><a href='#impl-From%3CLibrary%3E' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/libloading/lib.rs.html#182-186' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.from' class="method"><span id='from.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(lib: <a class="struct" href="../libloading/os/unix/struct.Library.html" title="struct libloading::os::unix::Library">Library</a>) -> <a class="struct" href="../libloading/struct.Library.html" title="struct libloading::Library">Library</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/libloading/lib.rs.html#183-185' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Performs the conversion.</p>
|
||
</div></div><h3 id='impl-From%3CLibrary%3E-1' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><<a class="struct" href="../libloading/struct.Library.html" title="struct libloading::Library">Library</a>> for <a class="struct" href="../libloading/os/unix/struct.Library.html" title="struct libloading::os::unix::Library">Library</a></code><a href='#impl-From%3CLibrary%3E-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#188-192' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.from-1' class="method"><span id='from.v-1' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(lib: <a class="struct" href="../libloading/struct.Library.html" title="struct libloading::Library">Library</a>) -> <a class="struct" href="../libloading/os/unix/struct.Library.html" title="struct libloading::os::unix::Library">Library</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/libloading/lib.rs.html#189-191' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Performs the conversion.</p>
|
||
</div></div><h3 id='impl-Send' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <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="../libloading/struct.Library.html" title="struct libloading::Library">Library</a></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#194' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'></div><h3 id='impl-Sync' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <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="../libloading/struct.Library.html" title="struct libloading::Library">Library</a></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#195' 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 = "libloading";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html> |