|
|
<!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 `libloading` crate."><meta name="keywords" content="rust, rustlang, rust-lang, libloading"><title>libloading - 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><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="shortcut icon" href="../favicon.ico"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc mod"><!--[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><a href='../libloading/index.html'><div class='logo-container'><img src='../rust-logo.png' alt='logo'></div></a><p class='location'>Crate libloading</p><div class="sidebar-elems"><a id='all-types' href='all.html'><p>See all libloading's items</p></a><div class="block items"><ul><li><a href="#modules">Modules</a></li><li><a href="#structs">Structs</a></li><li><a href="#types">Type Definitions</a></li></ul></div><p class='location'></p><script>window.sidebarCurrent = {name: 'libloading', ty: 'mod', relpath: '../'};</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"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><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='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#1-310' title='goto source code'>[src]</a></span><span class='in-band'>Crate <a class="mod" href=''>libloading</a></span></h1><div class='docblock'><p>A memory-safer wrapper around system dynamic library loading primitives.</p>
|
|
|
<p>Using this library allows loading <a href="struct.Library.html">dynamic libraries</a> (also known as
|
|
|
shared libraries) as well as use functions and static variables these libraries contain.</p>
|
|
|
<p>While the library does expose a cross-platform interface to load a library and find stuff
|
|
|
inside it, little is done to paper over the platform differences, especially where library
|
|
|
loading is involved. The documentation for each function will attempt to document such
|
|
|
differences on the best-effort basis.</p>
|
|
|
<p>Less safe, platform specific bindings are also available. See the
|
|
|
<a href="os/index.html"><code>os::platform</code></a> module for details.</p>
|
|
|
<h1 id="usage" class="section-header"><a href="#usage">Usage</a></h1>
|
|
|
<p>Add a dependency on this library to your <code>Cargo.toml</code>:</p>
|
|
|
<pre><code class="language-toml">[dependencies]
|
|
|
libloading = "0.5"
|
|
|
</code></pre>
|
|
|
<p>Then inside your project</p>
|
|
|
|
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
|
|
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">libloading</span> <span class="kw">as</span> <span class="ident">lib</span>;
|
|
|
|
|
|
<span class="kw">fn</span> <span class="ident">call_dynamic</span>() <span class="op">-</span><span class="op">></span> <span class="ident">lib</span>::<span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">u32</span><span class="op">></span> {
|
|
|
<span class="kw">let</span> <span class="ident">lib</span> <span class="op">=</span> <span class="ident">lib</span>::<span class="ident">Library</span>::<span class="ident">new</span>(<span class="string">"/path/to/liblibrary.so"</span>)<span class="question-mark">?</span>;
|
|
|
<span class="kw">unsafe</span> {
|
|
|
<span class="kw">let</span> <span class="ident">func</span>: <span class="ident">lib</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="op">-</span><span class="op">></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"my_func"</span>)<span class="question-mark">?</span>;
|
|
|
<span class="prelude-val">Ok</span>(<span class="ident">func</span>())
|
|
|
}
|
|
|
}</pre></div>
|
|
|
<p>The compiler will ensure that the loaded <code>function</code> will not outlive the <code>Library</code> it comes
|
|
|
from, preventing a common cause of undefined behaviour and memory safety problems.</p>
|
|
|
</div><h2 id='modules' class='section-header'><a href="#modules">Modules</a></h2>
|
|
|
<table><tr class='module-item'><td><a class="mod" href="changelog/index.html" title='libloading::changelog mod'>changelog</a></td><td class='docblock-short'><p>Project changelog</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="mod" href="os/index.html" title='libloading::os mod'>os</a></td><td class='docblock-short'><p>Unsafe, platform specific bindings to dynamic library loading facilities.</p>
|
|
|
</td></tr></table><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
|
|
|
<table><tr class='module-item'><td><a class="struct" href="struct.Library.html" title='libloading::Library struct'>Library</a></td><td class='docblock-short'><p>A loaded dynamic library.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="struct" href="struct.Symbol.html" title='libloading::Symbol struct'>Symbol</a></td><td class='docblock-short'><p>Symbol from a library.</p>
|
|
|
</td></tr></table><h2 id='types' class='section-header'><a href="#types">Type Definitions</a></h2>
|
|
|
<table><tr class='module-item'><td><a class="type" href="type.Result.html" title='libloading::Result type'>Result</a></td><td class='docblock-short'></td></tr></table></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> |
