mirror of
https://github.com/neogeek23/rusty_snek_gaem.git
synced 2026-02-05 03:28:41 +00:00
21 lines
16 KiB
HTML
21 lines
16 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 `DynamicLibrary` struct in crate `shared_library`."><meta name="keywords" content="rust, rustlang, rust-lang, DynamicLibrary"><title>shared_library::dynamic_library::DynamicLibrary - 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 DynamicLibrary</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.open">open</a><a href="#method.prepend_search_path">prepend_search_path</a><a href="#method.create_path">create_path</a><a href="#method.envvar">envvar</a><a href="#method.search_path">search_path</a><a href="#method.symbol">symbol</a><a href="#method.symbol_special">symbol_special</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Send">Send</a><a href="#impl-Sync">Sync</a><a href="#impl-Drop">Drop</a></div></div><p class='location'><a href='../index.html'>shared_library</a>::<wbr><a href='index.html'>dynamic_library</a></p><script>window.sidebarCurrent = {name: 'DynamicLibrary', 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'>shared_library</a>::<wbr><a href='index.html'>dynamic_library</a>::<wbr><a class="struct" href=''>DynamicLibrary</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/shared_library/dynamic_library.rs.html#23-25' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust struct'>pub struct DynamicLibrary { /* fields omitted */ }</pre></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="../../shared_library/dynamic_library/struct.DynamicLibrary.html" title="struct shared_library::dynamic_library::DynamicLibrary">DynamicLibrary</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/shared_library/dynamic_library.rs.html#51-158' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.open' class="method"><span id='open.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.open' class='fnname'>open</a>(filename: <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="https://doc.rust-lang.org/nightly/std/path/struct.Path.html" title="struct std::path::Path">Path</a>>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self, <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/shared_library/dynamic_library.rs.html#64-70' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Lazily loads the dynamic library named <code>filename</code> into memory and
|
||
then returns an opaque "handle" for that dynamic library.</p>
|
||
<p>Returns a handle to the calling process when passed <code>None</code>.</p>
|
||
</div><h4 id='method.prepend_search_path' class="method"><span id='prepend_search_path.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.prepend_search_path' class='fnname'>prepend_search_path</a>(path: &<a class="struct" href="https://doc.rust-lang.org/nightly/std/path/struct.Path.html" title="struct std::path::Path">Path</a>)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/shared_library/dynamic_library.rs.html#73-77' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Prepends a path to this process's search path for dynamic libraries</p>
|
||
</div><h4 id='method.create_path' class="method"><span id='create_path.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.create_path' class='fnname'>create_path</a>(path: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</a><a class="struct" href="https://doc.rust-lang.org/nightly/std/path/struct.PathBuf.html" title="struct std::path::PathBuf">PathBuf</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>) -> <a class="struct" href="https://doc.rust-lang.org/nightly/std/ffi/os_str/struct.OsString.html" title="struct std::ffi::os_str::OsString">OsString</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/shared_library/dynamic_library.rs.html#81-88' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>From a slice of paths, create a new vector which is suitable to be an
|
||
environment variable for this platforms dylib search path.</p>
|
||
</div><h4 id='method.envvar' class="method"><span id='envvar.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.envvar' class='fnname'>envvar</a>() -> &'static <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/shared_library/dynamic_library.rs.html#92-100' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns the environment variable for this process's dynamic library
|
||
search path</p>
|
||
</div><h4 id='method.search_path' class="method"><div class="important-traits"><div class='tooltip'>ⓘ<span class='tooltiptext'>Important traits for <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>></span></div><div class="content hidden"><h3 class="important">Important traits for <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>></h3><code class="content"><span class="where fmt-newline">impl <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="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>></span></code></div></div><span id='search_path.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.search_path' class='fnname'>search_path</a>() -> <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="struct" href="https://doc.rust-lang.org/nightly/std/path/struct.PathBuf.html" title="struct std::path::PathBuf">PathBuf</a>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/shared_library/dynamic_library.rs.html#109-114' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns the current search path for dynamic libraries being used by this
|
||
process</p>
|
||
</div><h4 id='method.symbol' class="method"><span id='symbol.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub unsafe fn <a href='#method.symbol' class='fnname'>symbol</a><T>(&self, symbol: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</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.pointer.html">*mut T</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/shared_library/dynamic_library.rs.html#121-132' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns the address of where symbol <code>symbol</code> was loaded into memory.</p>
|
||
<p>In POSIX compliant systems, we return 'Err' if the symbol was not found,
|
||
in this library or any of the libraries that were automatically loaded
|
||
when this library was loaded.</p>
|
||
</div><h4 id='method.symbol_special' class="method"><span id='symbol_special.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub unsafe fn <a href='#method.symbol_special' class='fnname'>symbol_special</a><T>(<br> handle: <a class="enum" href="../../shared_library/dynamic_library/enum.SpecialHandles.html" title="enum shared_library::dynamic_library::SpecialHandles">SpecialHandles</a>, <br> symbol: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a><br>) -> <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.pointer.html">*mut T</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/shared_library/dynamic_library.rs.html#141-157' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns the address of the first occurance of symbol <code>symbol</code> using the
|
||
default library search order if you use <code>SpecialHandles::Default</code>.</p>
|
||
<p>Returns the address of the next occurance of symbol <code>symbol</code> after the
|
||
current library in the default library search order if you use
|
||
<code>SpecialHandles::Next</code>.</p>
|
||
</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-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="../../shared_library/dynamic_library/struct.DynamicLibrary.html" title="struct shared_library::dynamic_library::DynamicLibrary">DynamicLibrary</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/shared_library/dynamic_library.rs.html#27' 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="../../shared_library/dynamic_library/struct.DynamicLibrary.html" title="struct shared_library::dynamic_library::DynamicLibrary">DynamicLibrary</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/shared_library/dynamic_library.rs.html#28' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'></div><h3 id='impl-Drop' 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/ops/drop/trait.Drop.html" title="trait core::ops::drop::Drop">Drop</a> for <a class="struct" href="../../shared_library/dynamic_library/struct.DynamicLibrary.html" title="struct shared_library::dynamic_library::DynamicLibrary">DynamicLibrary</a></code><a href='#impl-Drop' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/shared_library/dynamic_library.rs.html#30-38' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.drop' class="method"><span id='drop.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/ops/drop/trait.Drop.html#tymethod.drop' class='fnname'>drop</a>(&mut self)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/shared_library/dynamic_library.rs.html#31-37' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Executes the destructor for this type. <a href="https://doc.rust-lang.org/nightly/core/ops/drop/trait.Drop.html#tymethod.drop">Read more</a></p>
|
||
</div></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 = "shared_library";</script><script src="../../aliases.js"></script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html> |