101 lines
33 KiB
HTML
101 lines
33 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="A loaded dynamic library."><title>Library in libloading - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="libloading" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.0 (9fc6b4312 2025-01-07)" data-channel="1.84.0" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-044be391.svg"></head><body class="rustdoc struct"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../libloading/index.html">libloading</a><span class="version">0.8.5</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Library</a></h2><h3><a href="#implementations">Methods</a></h3><ul class="block method"><li><a href="#method.close" title="close">close</a></li><li><a href="#method.get" title="get">get</a></li><li><a href="#method.new" title="new">new</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block trait-implementation"><li><a href="#impl-Debug-for-Library" title="Debug">Debug</a></li><li><a href="#impl-From%3CLibrary%3E-for-Library" title="From<Library>">From<Library></a></li><li><a href="#impl-From%3CLibrary%3E-for-Library-1" title="From<Library>">From<Library></a></li><li><a href="#impl-Send-for-Library" title="Send">Send</a></li><li><a href="#impl-Sync-for-Library" title="Sync">Sync</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block synthetic-implementation"><li><a href="#impl-Freeze-for-Library" title="Freeze">Freeze</a></li><li><a href="#impl-RefUnwindSafe-for-Library" title="RefUnwindSafe">RefUnwindSafe</a></li><li><a href="#impl-Unpin-for-Library" title="Unpin">Unpin</a></li><li><a href="#impl-UnwindSafe-for-Library" title="UnwindSafe">UnwindSafe</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block blanket-implementation"><li><a href="#impl-Any-for-T" title="Any">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-T" title="Borrow<T>">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-T" title="BorrowMut<T>">BorrowMut<T></a></li><li><a href="#impl-From%3CT%3E-for-T" title="From<T>">From<T></a></li><li><a href="#impl-Into%3CU%3E-for-T" title="Into<U>">Into<U></a></li><li><a href="#impl-TryFrom%3CU%3E-for-T" title="TryFrom<U>">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E-for-T" title="TryInto<U>">TryInto<U></a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="index.html">In crate libloading</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="index.html">libloading</a></span><h1>Struct <span class="struct">Library</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../src/libloading/safe.rs.html#16">Source</a> </span></div><pre class="rust item-decl"><code>pub struct Library(<span class="comment">/* private fields */</span>);</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A loaded dynamic library.</p>
|
||
</div></details><h2 id="implementations" class="section-header">Implementations<a href="#implementations" class="anchor">§</a></h2><div id="implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-Library" class="impl"><a class="src rightside" href="../src/libloading/safe.rs.html#18-165">Source</a><a href="#impl-Library" class="anchor">§</a><h3 class="code-header">impl <a class="struct" href="struct.Library.html" title="struct libloading::Library">Library</a></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.new" class="method"><a class="src rightside" href="../src/libloading/safe.rs.html#84-86">Source</a><h4 class="code-header">pub unsafe fn <a href="#method.new" class="fn">new</a><P: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a><<a class="struct" href="https://doc.rust-lang.org/1.84.0/std/ffi/os_str/struct.OsStr.html" title="struct std::ffi::os_str::OsStr">OsStr</a>>>(filename: P) -> <a class="enum" href="https://doc.rust-lang.org/1.84.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="struct.Library.html" title="struct libloading::Library">Library</a>, <a class="enum" href="enum.Error.html" title="enum libloading::Error">Error</a>></h4></section></summary><div class="docblock"><p>Find and load a dynamic library.</p>
|
||
<p>The <code>filename</code> argument may be either:</p>
|
||
<ul>
|
||
<li>A library filename;</li>
|
||
<li>The absolute path to the library;</li>
|
||
<li>A relative (to the current working directory) path to the library.</li>
|
||
</ul>
|
||
<h5 id="safety"><a class="doc-anchor" href="#safety">§</a>Safety</h5>
|
||
<p>When a library is loaded, initialisation routines contained within it are executed.
|
||
For the purposes of safety, the execution of these routines is conceptually the same calling an
|
||
unknown foreign function and may impose arbitrary requirements on the caller for the call
|
||
to be sound.</p>
|
||
<p>Additionally, the callers of this function must also ensure that execution of the
|
||
termination routines contained within the library is safe as well. These routines may be
|
||
executed when the library is unloaded.</p>
|
||
<h5 id="thread-safety"><a class="doc-anchor" href="#thread-safety">§</a>Thread-safety</h5>
|
||
<p>The implementation strives to be as MT-safe as sanely possible, however on certain
|
||
platforms the underlying error-handling related APIs not always MT-safe. This library
|
||
shares these limitations on those platforms. In particular, on certain UNIX targets
|
||
<code>dlerror</code> is not MT-safe, resulting in garbage error messages in certain MT-scenarios.</p>
|
||
<p>Calling this function from multiple threads is not MT-safe if used in conjunction with
|
||
library filenames and the library search path is modified (<code>SetDllDirectory</code> function on
|
||
Windows, <code>{DY,}LD_LIBRARY_PATH</code> environment variable on UNIX).</p>
|
||
<h5 id="platform-specific-behaviour"><a class="doc-anchor" href="#platform-specific-behaviour">§</a>Platform-specific behaviour</h5>
|
||
<p>When a plain library filename is supplied, the locations in which the library is searched are
|
||
platform specific and cannot be adjusted in a portable manner. See the documentation for
|
||
the platform specific <a href="os/unix/struct.Library.html#method.new" title="associated function libloading::os::unix::Library::new"><code>os::unix::Library::new</code></a> and <a href="crate::os::windows::Library::new"><code>os::windows::Library::new</code></a> methods
|
||
for further information on library lookup behaviour.</p>
|
||
<p>If the <code>filename</code> specifies a library filename without a path and with the extension omitted,
|
||
the <code>.dll</code> extension is implicitly added on Windows.</p>
|
||
<h5 id="tips"><a class="doc-anchor" href="#tips">§</a>Tips</h5>
|
||
<p>Distributing your dynamic libraries under a filename common to all platforms (e.g.
|
||
<code>awesome.module</code>) allows you to avoid code which has to account for platform’s conventional
|
||
library filenames.</p>
|
||
<p>Strive to specify an absolute or at least a 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 flakiness in
|
||
programs.</p>
|
||
<h5 id="examples"><a class="doc-anchor" href="#examples">§</a>Examples</h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="comment">// Any of the following are valid.
|
||
</span><span class="kw">unsafe </span>{
|
||
<span class="kw">let _ </span>= Library::new(<span class="string">"/path/to/awesome.module"</span>).unwrap();
|
||
<span class="kw">let _ </span>= Library::new(<span class="string">"../awesome.module"</span>).unwrap();
|
||
<span class="kw">let _ </span>= Library::new(<span class="string">"libsomelib.so.1"</span>).unwrap();
|
||
}</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.get" class="method"><a class="src rightside" href="../src/libloading/safe.rs.html#148-150">Source</a><h4 class="code-header">pub unsafe fn <a href="#method.get" class="fn">get</a><'lib, T>(
|
||
&'lib self,
|
||
symbol: &[<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.u8.html">u8</a>],
|
||
) -> <a class="enum" href="https://doc.rust-lang.org/1.84.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="struct.Symbol.html" title="struct libloading::Symbol">Symbol</a><'lib, T>, <a class="enum" href="enum.Error.html" title="enum libloading::Error">Error</a>></h4></section></summary><div class="docblock"><p>Get a pointer to a function or static variable by symbol name.</p>
|
||
<p>The <code>symbol</code> may not contain any null bytes, with the exception of the last byte. Providing a
|
||
null-terminated <code>symbol</code> may help to avoid an allocation.</p>
|
||
<p>The symbol is interpreted as-is; no mangling is done. This means that symbols like <code>x::y</code> are
|
||
most likely invalid.</p>
|
||
<h5 id="safety-1"><a class="doc-anchor" href="#safety-1">§</a>Safety</h5>
|
||
<p>Users of this API must specify the correct type of the function or variable loaded.</p>
|
||
<h5 id="platform-specific-behaviour-1"><a class="doc-anchor" href="#platform-specific-behaviour-1">§</a>Platform-specific behaviour</h5>
|
||
<p>The implementation of thread-local variables is extremely platform specific and uses of such
|
||
variables that work on e.g. Linux may have unintended behaviour on other targets.</p>
|
||
<p>On POSIX implementations where the <code>dlerror</code> function is not confirmed to be MT-safe (such
|
||
as FreeBSD), this function will unconditionally return an error when the underlying <code>dlsym</code>
|
||
call returns a null pointer. There are rare situations where <code>dlsym</code> returns a genuine null
|
||
pointer without it being an error. If loading a null pointer is something you care about,
|
||
consider using the <a href="os/unix/struct.Library.html#method.get_singlethreaded" title="method libloading::os::unix::Library::get_singlethreaded"><code>os::unix::Library::get_singlethreaded</code></a> call.</p>
|
||
<h5 id="examples-1"><a class="doc-anchor" href="#examples-1">§</a>Examples</h5>
|
||
<p>Given a loaded library:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>lib = <span class="kw">unsafe </span>{
|
||
Library::new(<span class="string">"/path/to/awesome.module"</span>).unwrap()
|
||
};</code></pre></div>
|
||
<p>Loading and using a function looks like this:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">unsafe </span>{
|
||
<span class="kw">let </span>awesome_function: Symbol<<span class="kw">unsafe extern fn</span>(f64) -> f64> =
|
||
lib.get(<span class="string">b"awesome_function\0"</span>).unwrap();
|
||
awesome_function(<span class="number">0.42</span>);
|
||
}</code></pre></div>
|
||
<p>A static variable may also be loaded and inspected:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">unsafe </span>{
|
||
<span class="kw">let </span>awesome_variable: Symbol<<span class="kw-2">*mut </span>f64> = lib.get(<span class="string">b"awesome_variable\0"</span>).unwrap();
|
||
<span class="kw-2">**</span>awesome_variable = <span class="number">42.0</span>;
|
||
};</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.close" class="method"><a class="src rightside" href="../src/libloading/safe.rs.html#162-164">Source</a><h4 class="code-header">pub fn <a href="#method.close" class="fn">close</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/1.84.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.unit.html">()</a>, <a class="enum" href="enum.Error.html" title="enum libloading::Error">Error</a>></h4></section></summary><div class="docblock"><p>Unload the library.</p>
|
||
<p>This method might be a no-op, depending on the flags with which the <code>Library</code> was opened,
|
||
what library was opened or other platform specifics.</p>
|
||
<p>You only need to call this if you are interested in handling any errors that may arise when
|
||
library is unloaded. Otherwise the implementation of <code>Drop</code> for <code>Library</code> will close the
|
||
library and ignore the errors were they arise.</p>
|
||
<p>The underlying data structures may still get leaked if an error does occur.</p>
|
||
</div></details></div></details></div><h2 id="trait-implementations" class="section-header">Trait Implementations<a href="#trait-implementations" class="anchor">§</a></h2><div id="trait-implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-Debug-for-Library" class="impl"><a class="src rightside" href="../src/libloading/safe.rs.html#167-171">Source</a><a href="#impl-Debug-for-Library" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="struct.Library.html" title="struct libloading::Library">Library</a></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.fmt" class="method trait-impl"><a class="src rightside" href="../src/libloading/safe.rs.html#168-170">Source</a><a href="#method.fmt" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/fmt/trait.Debug.html#tymethod.fmt" class="fn">fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/1.84.0/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/1.84.0/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></h4></section></summary><div class='docblock'>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/1.84.0/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-From%3CLibrary%3E-for-Library" class="impl"><a class="src rightside" href="../src/libloading/safe.rs.html#173-177">Source</a><a href="#impl-From%3CLibrary%3E-for-Library" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><<a class="struct" href="os/unix/struct.Library.html" title="struct libloading::os::unix::Library">Library</a>> for <a class="struct" href="struct.Library.html" title="struct libloading::Library">Library</a></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.from" class="method trait-impl"><a class="src rightside" href="../src/libloading/safe.rs.html#174-176">Source</a><a href="#method.from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/convert/trait.From.html#tymethod.from" class="fn">from</a>(lib: <a class="struct" href="os/unix/struct.Library.html" title="struct libloading::os::unix::Library">Library</a>) -> <a class="struct" href="struct.Library.html" title="struct libloading::Library">Library</a></h4></section></summary><div class='docblock'>Converts to this type from the input type.</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-From%3CLibrary%3E-for-Library-1" class="impl"><a class="src rightside" href="../src/libloading/safe.rs.html#179-183">Source</a><a href="#impl-From%3CLibrary%3E-for-Library-1" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><<a class="struct" href="struct.Library.html" title="struct libloading::Library">Library</a>> for <a class="struct" href="os/unix/struct.Library.html" title="struct libloading::os::unix::Library">Library</a></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.from-1" class="method trait-impl"><a class="src rightside" href="../src/libloading/safe.rs.html#180-182">Source</a><a href="#method.from-1" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/convert/trait.From.html#tymethod.from" class="fn">from</a>(lib: <a class="struct" href="struct.Library.html" title="struct libloading::Library">Library</a>) -> <a class="struct" href="os/unix/struct.Library.html" title="struct libloading::os::unix::Library">Library</a></h4></section></summary><div class='docblock'>Converts to this type from the input type.</div></details></div></details><section id="impl-Send-for-Library" class="impl"><a class="src rightside" href="../src/libloading/safe.rs.html#185">Source</a><a href="#impl-Send-for-Library" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="struct.Library.html" title="struct libloading::Library">Library</a></h3></section><section id="impl-Sync-for-Library" class="impl"><a class="src rightside" href="../src/libloading/safe.rs.html#186">Source</a><a href="#impl-Sync-for-Library" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="struct.Library.html" title="struct libloading::Library">Library</a></h3></section></div><h2 id="synthetic-implementations" class="section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor">§</a></h2><div id="synthetic-implementations-list"><section id="impl-Freeze-for-Library" class="impl"><a href="#impl-Freeze-for-Library" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Freeze.html" title="trait core::marker::Freeze">Freeze</a> for <a class="struct" href="struct.Library.html" title="struct libloading::Library">Library</a></h3></section><section id="impl-RefUnwindSafe-for-Library" class="impl"><a href="#impl-RefUnwindSafe-for-Library" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="struct.Library.html" title="struct libloading::Library">Library</a></h3></section><section id="impl-Unpin-for-Library" class="impl"><a href="#impl-Unpin-for-Library" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="struct.Library.html" title="struct libloading::Library">Library</a></h3></section><section id="impl-UnwindSafe-for-Library" class="impl"><a href="#impl-UnwindSafe-for-Library" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a> for <a class="struct" href="struct.Library.html" title="struct libloading::Library">Library</a></h3></section></div><h2 id="blanket-implementations" class="section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor">§</a></h2><div id="blanket-implementations-list"><details class="toggle implementors-toggle"><summary><section id="impl-Any-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/any.rs.html#138">Source</a><a href="#impl-Any-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T<div class="where">where
|
||
T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/any.rs.html#139">Source</a><a href="#method.type_id" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/any/trait.Any.html#tymethod.type_id" class="fn">type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/1.84.0/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></h4></section></summary><div class='docblock'>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/1.84.0/core/any/trait.Any.html#tymethod.type_id">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/borrow.rs.html#209">Source</a><a href="#impl-Borrow%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><T> for T<div class="where">where
|
||
T: ?<a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/borrow.rs.html#211">Source</a><a href="#method.borrow" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/borrow/trait.Borrow.html#tymethod.borrow" class="fn">borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&T</a></h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.84.0/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/borrow.rs.html#217">Source</a><a href="#impl-BorrowMut%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T<div class="where">where
|
||
T: ?<a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow_mut" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/borrow.rs.html#218">Source</a><a href="#method.borrow_mut" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fn">borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&mut T</a></h4></section></summary><div class='docblock'>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.84.0/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/convert/mod.rs.html#765">Source</a><a href="#impl-From%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for T</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.from-2" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/convert/mod.rs.html#768">Source</a><a href="#method.from-2" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/convert/trait.From.html#tymethod.from" class="fn">from</a>(t: T) -> T</h4></section></summary><div class="docblock"><p>Returns the argument unchanged.</p>
|
||
</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Into%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/convert/mod.rs.html#748-750">Source</a><a href="#impl-Into%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><U> for T<div class="where">where
|
||
U: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/convert/mod.rs.html#758">Source</a><a href="#method.into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/convert/trait.Into.html#tymethod.into" class="fn">into</a>(self) -> U</h4></section></summary><div class="docblock"><p>Calls <code>U::from(self)</code>.</p>
|
||
<p>That is, this conversion is whatever the implementation of
|
||
<code><a href="https://doc.rust-lang.org/1.84.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for U</code> chooses to do.</p>
|
||
</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/convert/mod.rs.html#805-807">Source</a><a href="#impl-TryFrom%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U> for T<div class="where">where
|
||
U: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/convert/mod.rs.html#809">Source</a><a href="#associatedtype.Error-1" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryFrom.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="enum" href="https://doc.rust-lang.org/1.84.0/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="toggle method-toggle" open><summary><section id="method.try_from" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/convert/mod.rs.html#812">Source</a><a href="#method.try_from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryFrom.html#tymethod.try_from" class="fn">try_from</a>(value: U) -> <a class="enum" href="https://doc.rust-lang.org/1.84.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <T as <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/convert/mod.rs.html#790-792">Source</a><a href="#impl-TryInto%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a><U> for T<div class="where">where
|
||
U: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/convert/mod.rs.html#794">Source</a><a href="#associatedtype.Error" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryInto.html#associatedtype.Error" class="associatedtype">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="toggle method-toggle" open><summary><section id="method.try_into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/convert/mod.rs.html#797">Source</a><a href="#method.try_into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryInto.html#tymethod.try_into" class="fn">try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/1.84.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><U, <U as <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details></div></section></div></main></body></html> |