199 lines
52 KiB
HTML
199 lines
52 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 memory map builder, providing advanced options and flags for specifying memory map behavior."><title>MmapOptions in memmap2 - 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="memmap2" 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="../memmap2/index.html">memmap2</a><span class="version">0.9.5</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Mmap<wbr>Options</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#safety" title="Safety">Safety</a></li></ul><h3><a href="#implementations">Methods</a></h3><ul class="block method"><li><a href="#method.huge" title="huge">huge</a></li><li><a href="#method.len" title="len">len</a></li><li><a href="#method.map" title="map">map</a></li><li><a href="#method.map_anon" title="map_anon">map_anon</a></li><li><a href="#method.map_copy" title="map_copy">map_copy</a></li><li><a href="#method.map_copy_read_only" title="map_copy_read_only">map_copy_read_only</a></li><li><a href="#method.map_exec" title="map_exec">map_exec</a></li><li><a href="#method.map_mut" title="map_mut">map_mut</a></li><li><a href="#method.map_raw" title="map_raw">map_raw</a></li><li><a href="#method.map_raw_read_only" title="map_raw_read_only">map_raw_read_only</a></li><li><a href="#method.new" title="new">new</a></li><li><a href="#method.offset" title="offset">offset</a></li><li><a href="#method.populate" title="populate">populate</a></li><li><a href="#method.stack" title="stack">stack</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block trait-implementation"><li><a href="#impl-Clone-for-MmapOptions" title="Clone">Clone</a></li><li><a href="#impl-Debug-for-MmapOptions" title="Debug">Debug</a></li><li><a href="#impl-Default-for-MmapOptions" title="Default">Default</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block synthetic-implementation"><li><a href="#impl-Freeze-for-MmapOptions" title="Freeze">Freeze</a></li><li><a href="#impl-RefUnwindSafe-for-MmapOptions" title="RefUnwindSafe">RefUnwindSafe</a></li><li><a href="#impl-Send-for-MmapOptions" title="Send">Send</a></li><li><a href="#impl-Sync-for-MmapOptions" title="Sync">Sync</a></li><li><a href="#impl-Unpin-for-MmapOptions" title="Unpin">Unpin</a></li><li><a href="#impl-UnwindSafe-for-MmapOptions" 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-CloneToUninit-for-T" title="CloneToUninit">CloneToUninit</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-ToOwned-for-T" title="ToOwned">ToOwned</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 memmap2</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">memmap2</a></span><h1>Struct <span class="struct">MmapOptions</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/memmap2/lib.rs.html#140-146">Source</a> </span></div><pre class="rust item-decl"><code>pub struct MmapOptions { <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 memory map builder, providing advanced options and flags for specifying memory map behavior.</p>
|
|
<p><code>MmapOptions</code> can be used to create an anonymous memory map using <a href="struct.MmapOptions.html#method.map_anon" title="method memmap2::MmapOptions::map_anon"><code>map_anon()</code></a>, or a
|
|
file-backed memory map using one of <a href="struct.MmapOptions.html#method.map" title="method memmap2::MmapOptions::map"><code>map()</code></a>, <a href="struct.MmapOptions.html#method.map_mut" title="method memmap2::MmapOptions::map_mut"><code>map_mut()</code></a>, <a href="struct.MmapOptions.html#method.map_exec" title="method memmap2::MmapOptions::map_exec"><code>map_exec()</code></a>,
|
|
<a href="struct.MmapOptions.html#method.map_copy" title="method memmap2::MmapOptions::map_copy"><code>map_copy()</code></a>, or <a href="struct.MmapOptions.html#method.map_copy_read_only" title="method memmap2::MmapOptions::map_copy_read_only"><code>map_copy_read_only()</code></a>.</p>
|
|
<h3 id="safety"><a class="doc-anchor" href="#safety">§</a>Safety</h3>
|
|
<p>All file-backed memory map constructors are marked <code>unsafe</code> because of the potential for
|
|
<em>Undefined Behavior</em> (UB) using the map if the underlying file is subsequently modified, in or
|
|
out of process. Applications must consider the risk and take appropriate precautions when
|
|
using file-backed maps. Solutions such as file permissions, locks or process-private (e.g.
|
|
unlinked) files exist but are platform specific and limited.</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-MmapOptions" class="impl"><a class="src rightside" href="../src/memmap2/lib.rs.html#148-565">Source</a><a href="#impl-MmapOptions" class="anchor">§</a><h3 class="code-header">impl <a class="struct" href="struct.MmapOptions.html" title="struct memmap2::MmapOptions">MmapOptions</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/memmap2/lib.rs.html#171-173">Source</a><h4 class="code-header">pub fn <a href="#method.new" class="fn">new</a>() -> <a class="struct" href="struct.MmapOptions.html" title="struct memmap2::MmapOptions">MmapOptions</a></h4></section></summary><div class="docblock"><p>Creates a new set of options for configuring and creating a memory map.</p>
|
|
<h5 id="example"><a class="doc-anchor" href="#example">§</a>Example</h5>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>memmap2::{MmapMut, MmapOptions};
|
|
|
|
<span class="comment">// Create a new memory map builder.
|
|
</span><span class="kw">let </span><span class="kw-2">mut </span>mmap_options = MmapOptions::new();
|
|
|
|
<span class="comment">// Configure the memory map builder using option setters, then create
|
|
// a memory map using one of `mmap_options.map_anon`, `mmap_options.map`,
|
|
// `mmap_options.map_mut`, `mmap_options.map_exec`, or `mmap_options.map_copy`:
|
|
</span><span class="kw">let </span><span class="kw-2">mut </span>mmap: MmapMut = mmap_options.len(<span class="number">36</span>).map_anon()<span class="question-mark">?</span>;
|
|
|
|
<span class="comment">// Use the memory map:
|
|
</span>mmap.copy_from_slice(<span class="string">b"...data to copy to the memory map..."</span>);</code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.offset" class="method"><a class="src rightside" href="../src/memmap2/lib.rs.html#198-201">Source</a><h4 class="code-header">pub fn <a href="#method.offset" class="fn">offset</a>(&mut self, offset: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.u64.html">u64</a>) -> &mut Self</h4></section></summary><div class="docblock"><p>Configures the memory map to start at byte <code>offset</code> from the beginning of the file.</p>
|
|
<p>This option has no effect on anonymous memory maps.</p>
|
|
<p>By default, the offset is 0.</p>
|
|
<h5 id="example-1"><a class="doc-anchor" href="#example-1">§</a>Example</h5>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>memmap2::MmapOptions;
|
|
<span class="kw">use </span>std::fs::File;
|
|
|
|
<span class="kw">let </span>mmap = <span class="kw">unsafe </span>{
|
|
MmapOptions::new()
|
|
.offset(<span class="number">30</span>)
|
|
.map(<span class="kw-2">&</span>File::open(<span class="string">"LICENSE-APACHE"</span>)<span class="question-mark">?</span>)<span class="question-mark">?
|
|
</span>};
|
|
<span class="macro">assert_eq!</span>(<span class="kw-2">&</span><span class="string">b"Apache License"</span>[..],
|
|
<span class="kw-2">&</span>mmap[..<span class="number">14</span>]);</code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.len" class="method"><a class="src rightside" href="../src/memmap2/lib.rs.html#225-228">Source</a><h4 class="code-header">pub fn <a href="#method.len" class="fn">len</a>(&mut self, len: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.usize.html">usize</a>) -> &mut Self</h4></section></summary><div class="docblock"><p>Configures the created memory mapped buffer to be <code>len</code> bytes long.</p>
|
|
<p>This option is mandatory for anonymous memory maps.</p>
|
|
<p>For file-backed memory maps, the length will default to the file length.</p>
|
|
<h5 id="example-2"><a class="doc-anchor" href="#example-2">§</a>Example</h5>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>memmap2::MmapOptions;
|
|
<span class="kw">use </span>std::fs::File;
|
|
|
|
<span class="kw">let </span>mmap = <span class="kw">unsafe </span>{
|
|
MmapOptions::new()
|
|
.len(<span class="number">9</span>)
|
|
.map(<span class="kw-2">&</span>File::open(<span class="string">"README.md"</span>)<span class="question-mark">?</span>)<span class="question-mark">?
|
|
</span>};
|
|
<span class="macro">assert_eq!</span>(<span class="kw-2">&</span><span class="string">b"# memmap2"</span>[..], <span class="kw-2">&</span>mmap[..]);</code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.stack" class="method"><a class="src rightside" href="../src/memmap2/lib.rs.html#280-283">Source</a><h4 class="code-header">pub fn <a href="#method.stack" class="fn">stack</a>(&mut self) -> &mut Self</h4></section></summary><div class="docblock"><p>Configures the anonymous memory map to be suitable for a process or thread stack.</p>
|
|
<p>This option corresponds to the <code>MAP_STACK</code> flag on Linux. It has no effect on Windows.</p>
|
|
<p>This option has no effect on file-backed memory maps.</p>
|
|
<h5 id="example-3"><a class="doc-anchor" href="#example-3">§</a>Example</h5>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>memmap2::MmapOptions;
|
|
|
|
<span class="kw">let </span>stack = MmapOptions::new().stack().len(<span class="number">4096</span>).map_anon();</code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.huge" class="method"><a class="src rightside" href="../src/memmap2/lib.rs.html#307-310">Source</a><h4 class="code-header">pub fn <a href="#method.huge" class="fn">huge</a>(&mut self, page_bits: <a class="enum" href="https://doc.rust-lang.org/1.84.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.u8.html">u8</a>>) -> &mut Self</h4></section></summary><div class="docblock"><p>Configures the anonymous memory map to be allocated using huge pages.</p>
|
|
<p>This option corresponds to the <code>MAP_HUGETLB</code> flag on Linux. It has no effect on Windows.</p>
|
|
<p>The size of the requested page can be specified in page bits. If not provided, the system
|
|
default is requested. The requested length should be a multiple of this, or the mapping
|
|
will fail.</p>
|
|
<p>This option has no effect on file-backed memory maps.</p>
|
|
<h5 id="example-4"><a class="doc-anchor" href="#example-4">§</a>Example</h5>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>memmap2::MmapOptions;
|
|
|
|
<span class="kw">let </span>stack = MmapOptions::new().huge(<span class="prelude-val">Some</span>(<span class="number">21</span>)).len(<span class="number">2</span><span class="kw-2">*</span><span class="number">1024</span><span class="kw-2">*</span><span class="number">1024</span>).map_anon();</code></pre></div>
|
|
<p>The number 21 corresponds to <code>MAP_HUGE_2MB</code>. See mmap(2) for more details.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.populate" class="method"><a class="src rightside" href="../src/memmap2/lib.rs.html#334-337">Source</a><h4 class="code-header">pub fn <a href="#method.populate" class="fn">populate</a>(&mut self) -> &mut Self</h4></section></summary><div class="docblock"><p>Populate (prefault) page tables for a mapping.</p>
|
|
<p>For a file mapping, this causes read-ahead on the file. This will help to reduce blocking on page faults later.</p>
|
|
<p>This option corresponds to the <code>MAP_POPULATE</code> flag on Linux. It has no effect on Windows.</p>
|
|
<h5 id="example-5"><a class="doc-anchor" href="#example-5">§</a>Example</h5>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>memmap2::MmapOptions;
|
|
<span class="kw">use </span>std::fs::File;
|
|
|
|
<span class="kw">let </span>file = File::open(<span class="string">"LICENSE-MIT"</span>)<span class="question-mark">?</span>;
|
|
|
|
<span class="kw">let </span>mmap = <span class="kw">unsafe </span>{
|
|
MmapOptions::new().populate().map(<span class="kw-2">&</span>file)<span class="question-mark">?
|
|
</span>};
|
|
|
|
<span class="macro">assert_eq!</span>(<span class="kw-2">&</span><span class="string">b"Copyright"</span>[..], <span class="kw-2">&</span>mmap[..<span class="number">9</span>]);</code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.map" class="method"><a class="src rightside" href="../src/memmap2/lib.rs.html#371-376">Source</a><h4 class="code-header">pub unsafe fn <a href="#method.map" class="fn">map</a><T: <a class="trait" href="trait.MmapAsRawDesc.html" title="trait memmap2::MmapAsRawDesc">MmapAsRawDesc</a>>(&self, file: T) -> <a class="type" href="https://doc.rust-lang.org/1.84.0/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="struct" href="struct.Mmap.html" title="struct memmap2::Mmap">Mmap</a>></h4></section></summary><div class="docblock"><p>Creates a read-only memory map backed by a file.</p>
|
|
<h5 id="safety-1"><a class="doc-anchor" href="#safety-1">§</a>Safety</h5>
|
|
<p>See the <a href="struct.MmapOptions.html" title="struct memmap2::MmapOptions">type-level</a> docs for why this function is unsafe.</p>
|
|
<h5 id="errors"><a class="doc-anchor" href="#errors">§</a>Errors</h5>
|
|
<p>This method returns an error when the underlying system call fails, which can happen for a
|
|
variety of reasons, such as when the file is not open with read permissions.</p>
|
|
<h5 id="example-6"><a class="doc-anchor" href="#example-6">§</a>Example</h5>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>memmap2::MmapOptions;
|
|
<span class="kw">use </span>std::fs::File;
|
|
<span class="kw">use </span>std::io::Read;
|
|
|
|
<span class="kw">let </span><span class="kw-2">mut </span>file = File::open(<span class="string">"LICENSE-APACHE"</span>)<span class="question-mark">?</span>;
|
|
|
|
<span class="kw">let </span><span class="kw-2">mut </span>contents = Vec::new();
|
|
file.read_to_end(<span class="kw-2">&mut </span>contents)<span class="question-mark">?</span>;
|
|
|
|
<span class="kw">let </span>mmap = <span class="kw">unsafe </span>{
|
|
MmapOptions::new().map(<span class="kw-2">&</span>file)<span class="question-mark">?
|
|
</span>};
|
|
|
|
<span class="macro">assert_eq!</span>(<span class="kw-2">&</span>contents[..], <span class="kw-2">&</span>mmap[..]);</code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.map_exec" class="method"><a class="src rightside" href="../src/memmap2/lib.rs.html#388-393">Source</a><h4 class="code-header">pub unsafe fn <a href="#method.map_exec" class="fn">map_exec</a><T: <a class="trait" href="trait.MmapAsRawDesc.html" title="trait memmap2::MmapAsRawDesc">MmapAsRawDesc</a>>(&self, file: T) -> <a class="type" href="https://doc.rust-lang.org/1.84.0/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="struct" href="struct.Mmap.html" title="struct memmap2::Mmap">Mmap</a>></h4></section></summary><div class="docblock"><p>Creates a readable and executable memory map backed by a file.</p>
|
|
<h5 id="safety-2"><a class="doc-anchor" href="#safety-2">§</a>Safety</h5>
|
|
<p>See the <a href="struct.MmapOptions.html" title="struct memmap2::MmapOptions">type-level</a> docs for why this function is unsafe.</p>
|
|
<h5 id="errors-1"><a class="doc-anchor" href="#errors-1">§</a>Errors</h5>
|
|
<p>This method returns an error when the underlying system call fails, which can happen for a
|
|
variety of reasons, such as when the file is not open with read permissions.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.map_mut" class="method"><a class="src rightside" href="../src/memmap2/lib.rs.html#432-437">Source</a><h4 class="code-header">pub unsafe fn <a href="#method.map_mut" class="fn">map_mut</a><T: <a class="trait" href="trait.MmapAsRawDesc.html" title="trait memmap2::MmapAsRawDesc">MmapAsRawDesc</a>>(&self, file: T) -> <a class="type" href="https://doc.rust-lang.org/1.84.0/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="struct" href="struct.MmapMut.html" title="struct memmap2::MmapMut">MmapMut</a>></h4></section></summary><div class="docblock"><p>Creates a writeable memory map backed by a file.</p>
|
|
<h5 id="safety-3"><a class="doc-anchor" href="#safety-3">§</a>Safety</h5>
|
|
<p>See the <a href="struct.MmapOptions.html" title="struct memmap2::MmapOptions">type-level</a> docs for why this function is unsafe.</p>
|
|
<h5 id="errors-2"><a class="doc-anchor" href="#errors-2">§</a>Errors</h5>
|
|
<p>This method returns an error when the underlying system call fails, which can happen for a
|
|
variety of reasons, such as when the file is not open with read and write permissions.</p>
|
|
<h5 id="example-7"><a class="doc-anchor" href="#example-7">§</a>Example</h5>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>std::fs::OpenOptions;
|
|
<span class="kw">use </span>std::path::PathBuf;
|
|
|
|
<span class="kw">use </span>memmap2::MmapOptions;
|
|
<span class="kw">let </span>path: PathBuf = <span class="comment">/* path to file */
|
|
</span><span class="kw">let </span>file = OpenOptions::new().read(<span class="bool-val">true</span>).write(<span class="bool-val">true</span>).create(<span class="bool-val">true</span>).open(<span class="kw-2">&</span>path)<span class="question-mark">?</span>;
|
|
file.set_len(<span class="number">13</span>)<span class="question-mark">?</span>;
|
|
|
|
<span class="kw">let </span><span class="kw-2">mut </span>mmap = <span class="kw">unsafe </span>{
|
|
MmapOptions::new().map_mut(<span class="kw-2">&</span>file)<span class="question-mark">?
|
|
</span>};
|
|
|
|
mmap.copy_from_slice(<span class="string">b"Hello, world!"</span>);</code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.map_copy" class="method"><a class="src rightside" href="../src/memmap2/lib.rs.html#467-472">Source</a><h4 class="code-header">pub unsafe fn <a href="#method.map_copy" class="fn">map_copy</a><T: <a class="trait" href="trait.MmapAsRawDesc.html" title="trait memmap2::MmapAsRawDesc">MmapAsRawDesc</a>>(&self, file: T) -> <a class="type" href="https://doc.rust-lang.org/1.84.0/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="struct" href="struct.MmapMut.html" title="struct memmap2::MmapMut">MmapMut</a>></h4></section></summary><div class="docblock"><p>Creates a copy-on-write memory map backed by a file.</p>
|
|
<p>Data written to the memory map will not be visible by other processes,
|
|
and will not be carried through to the underlying file.</p>
|
|
<h5 id="safety-4"><a class="doc-anchor" href="#safety-4">§</a>Safety</h5>
|
|
<p>See the <a href="struct.MmapOptions.html" title="struct memmap2::MmapOptions">type-level</a> docs for why this function is unsafe.</p>
|
|
<h5 id="errors-3"><a class="doc-anchor" href="#errors-3">§</a>Errors</h5>
|
|
<p>This method returns an error when the underlying system call fails, which can happen for a
|
|
variety of reasons, such as when the file is not open with writable permissions.</p>
|
|
<h5 id="example-8"><a class="doc-anchor" href="#example-8">§</a>Example</h5>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>memmap2::MmapOptions;
|
|
<span class="kw">use </span>std::fs::File;
|
|
<span class="kw">use </span>std::io::Write;
|
|
|
|
<span class="kw">let </span>file = File::open(<span class="string">"LICENSE-APACHE"</span>)<span class="question-mark">?</span>;
|
|
<span class="kw">let </span><span class="kw-2">mut </span>mmap = <span class="kw">unsafe </span>{ MmapOptions::new().map_copy(<span class="kw-2">&</span>file)<span class="question-mark">? </span>};
|
|
(<span class="kw-2">&mut </span>mmap[..]).write_all(<span class="string">b"Hello, world!"</span>)<span class="question-mark">?</span>;</code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.map_copy_read_only" class="method"><a class="src rightside" href="../src/memmap2/lib.rs.html#506-511">Source</a><h4 class="code-header">pub unsafe fn <a href="#method.map_copy_read_only" class="fn">map_copy_read_only</a><T: <a class="trait" href="trait.MmapAsRawDesc.html" title="trait memmap2::MmapAsRawDesc">MmapAsRawDesc</a>>(
|
|
&self,
|
|
file: T,
|
|
) -> <a class="type" href="https://doc.rust-lang.org/1.84.0/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="struct" href="struct.Mmap.html" title="struct memmap2::Mmap">Mmap</a>></h4></section></summary><div class="docblock"><p>Creates a copy-on-write read-only memory map backed by a file.</p>
|
|
<h5 id="safety-5"><a class="doc-anchor" href="#safety-5">§</a>Safety</h5>
|
|
<p>See the <a href="struct.MmapOptions.html" title="struct memmap2::MmapOptions">type-level</a> docs for why this function is unsafe.</p>
|
|
<h5 id="errors-4"><a class="doc-anchor" href="#errors-4">§</a>Errors</h5>
|
|
<p>This method returns an error when the underlying system call fails, which can happen for a
|
|
variety of reasons, such as when the file is not open with read permissions.</p>
|
|
<h5 id="example-9"><a class="doc-anchor" href="#example-9">§</a>Example</h5>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>memmap2::MmapOptions;
|
|
<span class="kw">use </span>std::fs::File;
|
|
<span class="kw">use </span>std::io::Read;
|
|
|
|
<span class="kw">let </span><span class="kw-2">mut </span>file = File::open(<span class="string">"README.md"</span>)<span class="question-mark">?</span>;
|
|
|
|
<span class="kw">let </span><span class="kw-2">mut </span>contents = Vec::new();
|
|
file.read_to_end(<span class="kw-2">&mut </span>contents)<span class="question-mark">?</span>;
|
|
|
|
<span class="kw">let </span>mmap = <span class="kw">unsafe </span>{
|
|
MmapOptions::new().map_copy_read_only(<span class="kw-2">&</span>file)<span class="question-mark">?
|
|
</span>};
|
|
|
|
<span class="macro">assert_eq!</span>(<span class="kw-2">&</span>contents[..], <span class="kw-2">&</span>mmap[..]);</code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.map_anon" class="method"><a class="src rightside" href="../src/memmap2/lib.rs.html#523-536">Source</a><h4 class="code-header">pub fn <a href="#method.map_anon" class="fn">map_anon</a>(&self) -> <a class="type" href="https://doc.rust-lang.org/1.84.0/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="struct" href="struct.MmapMut.html" title="struct memmap2::MmapMut">MmapMut</a>></h4></section></summary><div class="docblock"><p>Creates an anonymous memory map.</p>
|
|
<p>The memory map length should be configured using <a href="struct.MmapOptions.html#method.len" title="method memmap2::MmapOptions::len"><code>MmapOptions::len()</code></a>
|
|
before creating an anonymous memory map, otherwise a zero-length mapping
|
|
will be crated.</p>
|
|
<h5 id="errors-5"><a class="doc-anchor" href="#errors-5">§</a>Errors</h5>
|
|
<p>This method returns an error when the underlying system call fails or
|
|
when <code>len > isize::MAX</code>.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.map_raw" class="method"><a class="src rightside" href="../src/memmap2/lib.rs.html#544-549">Source</a><h4 class="code-header">pub fn <a href="#method.map_raw" class="fn">map_raw</a><T: <a class="trait" href="trait.MmapAsRawDesc.html" title="trait memmap2::MmapAsRawDesc">MmapAsRawDesc</a>>(&self, file: T) -> <a class="type" href="https://doc.rust-lang.org/1.84.0/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="struct" href="struct.MmapRaw.html" title="struct memmap2::MmapRaw">MmapRaw</a>></h4></section></summary><div class="docblock"><p>Creates a raw memory map.</p>
|
|
<h5 id="errors-6"><a class="doc-anchor" href="#errors-6">§</a>Errors</h5>
|
|
<p>This method returns an error when the underlying system call fails, which can happen for a
|
|
variety of reasons, such as when the file is not open with read and write permissions.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.map_raw_read_only" class="method"><a class="src rightside" href="../src/memmap2/lib.rs.html#559-564">Source</a><h4 class="code-header">pub fn <a href="#method.map_raw_read_only" class="fn">map_raw_read_only</a><T: <a class="trait" href="trait.MmapAsRawDesc.html" title="trait memmap2::MmapAsRawDesc">MmapAsRawDesc</a>>(&self, file: T) -> <a class="type" href="https://doc.rust-lang.org/1.84.0/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="struct" href="struct.MmapRaw.html" title="struct memmap2::MmapRaw">MmapRaw</a>></h4></section></summary><div class="docblock"><p>Creates a read-only raw memory map</p>
|
|
<p>This is primarily useful to avoid intermediate <code>Mmap</code> instances when
|
|
read-only access to files modified elsewhere are required.</p>
|
|
<h5 id="errors-7"><a class="doc-anchor" href="#errors-7">§</a>Errors</h5>
|
|
<p>This method returns an error when the underlying system call fails</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-Clone-for-MmapOptions" class="impl"><a class="src rightside" href="../src/memmap2/lib.rs.html#139">Source</a><a href="#impl-Clone-for-MmapOptions" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="struct" href="struct.MmapOptions.html" title="struct memmap2::MmapOptions">MmapOptions</a></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.clone" class="method trait-impl"><a class="src rightside" href="../src/memmap2/lib.rs.html#139">Source</a><a href="#method.clone" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/clone/trait.Clone.html#tymethod.clone" class="fn">clone</a>(&self) -> <a class="struct" href="struct.MmapOptions.html" title="struct memmap2::MmapOptions">MmapOptions</a></h4></section></summary><div class='docblock'>Returns a copy of the value. <a href="https://doc.rust-lang.org/1.84.0/core/clone/trait.Clone.html#tymethod.clone">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.clone_from" class="method trait-impl"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="src" href="https://doc.rust-lang.org/1.84.0/src/core/clone.rs.html#174">Source</a></span><a href="#method.clone_from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/clone/trait.Clone.html#method.clone_from" class="fn">clone_from</a>(&mut self, source: &Self)</h4></section></summary><div class='docblock'>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/1.84.0/core/clone/trait.Clone.html#method.clone_from">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Debug-for-MmapOptions" class="impl"><a class="src rightside" href="../src/memmap2/lib.rs.html#139">Source</a><a href="#impl-Debug-for-MmapOptions" 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.MmapOptions.html" title="struct memmap2::MmapOptions">MmapOptions</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/memmap2/lib.rs.html#139">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-Default-for-MmapOptions" class="impl"><a class="src rightside" href="../src/memmap2/lib.rs.html#139">Source</a><a href="#impl-Default-for-MmapOptions" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/default/trait.Default.html" title="trait core::default::Default">Default</a> for <a class="struct" href="struct.MmapOptions.html" title="struct memmap2::MmapOptions">MmapOptions</a></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.default" class="method trait-impl"><a class="src rightside" href="../src/memmap2/lib.rs.html#139">Source</a><a href="#method.default" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/default/trait.Default.html#tymethod.default" class="fn">default</a>() -> <a class="struct" href="struct.MmapOptions.html" title="struct memmap2::MmapOptions">MmapOptions</a></h4></section></summary><div class='docblock'>Returns the “default value” for a type. <a href="https://doc.rust-lang.org/1.84.0/core/default/trait.Default.html#tymethod.default">Read more</a></div></details></div></details></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-MmapOptions" class="impl"><a href="#impl-Freeze-for-MmapOptions" 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.MmapOptions.html" title="struct memmap2::MmapOptions">MmapOptions</a></h3></section><section id="impl-RefUnwindSafe-for-MmapOptions" class="impl"><a href="#impl-RefUnwindSafe-for-MmapOptions" 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.MmapOptions.html" title="struct memmap2::MmapOptions">MmapOptions</a></h3></section><section id="impl-Send-for-MmapOptions" class="impl"><a href="#impl-Send-for-MmapOptions" 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.MmapOptions.html" title="struct memmap2::MmapOptions">MmapOptions</a></h3></section><section id="impl-Sync-for-MmapOptions" class="impl"><a href="#impl-Sync-for-MmapOptions" 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.MmapOptions.html" title="struct memmap2::MmapOptions">MmapOptions</a></h3></section><section id="impl-Unpin-for-MmapOptions" class="impl"><a href="#impl-Unpin-for-MmapOptions" 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.MmapOptions.html" title="struct memmap2::MmapOptions">MmapOptions</a></h3></section><section id="impl-UnwindSafe-for-MmapOptions" class="impl"><a href="#impl-UnwindSafe-for-MmapOptions" 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.MmapOptions.html" title="struct memmap2::MmapOptions">MmapOptions</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-CloneToUninit-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/clone.rs.html#273">Source</a><a href="#impl-CloneToUninit-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/clone/trait.CloneToUninit.html" title="trait core::clone::CloneToUninit">CloneToUninit</a> for T<div class="where">where
|
|
T: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.clone_to_uninit" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/clone.rs.html#275">Source</a><a href="#method.clone_to_uninit" class="anchor">§</a><h4 class="code-header">unsafe fn <a href="https://doc.rust-lang.org/1.84.0/core/clone/trait.CloneToUninit.html#tymethod.clone_to_uninit" class="fn">clone_to_uninit</a>(&self, dst: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.pointer.html">*mut </a><a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.u8.html">u8</a>)</h4></section></summary><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span><span>This is a nightly-only experimental API. (<code>clone_to_uninit</code>)</span></div></span><div class='docblock'>Performs copy-assignment from <code>self</code> to <code>dst</code>. <a href="https://doc.rust-lang.org/1.84.0/core/clone/trait.CloneToUninit.html#tymethod.clone_to_uninit">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" 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" 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-ToOwned-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/alloc/borrow.rs.html#82-84">Source</a><a href="#impl-ToOwned-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.84.0/alloc/borrow/trait.ToOwned.html" title="trait alloc::borrow::ToOwned">ToOwned</a> for T<div class="where">where
|
|
T: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Owned" class="associatedtype trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/alloc/borrow.rs.html#86">Source</a><a href="#associatedtype.Owned" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.84.0/alloc/borrow/trait.ToOwned.html#associatedtype.Owned" class="associatedtype">Owned</a> = T</h4></section></summary><div class='docblock'>The resulting type after obtaining ownership.</div></details><details class="toggle method-toggle" open><summary><section id="method.to_owned" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/alloc/borrow.rs.html#87">Source</a><a href="#method.to_owned" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/alloc/borrow/trait.ToOwned.html#tymethod.to_owned" class="fn">to_owned</a>(&self) -> T</h4></section></summary><div class='docblock'>Creates owned data from borrowed data, usually by cloning. <a href="https://doc.rust-lang.org/1.84.0/alloc/borrow/trait.ToOwned.html#tymethod.to_owned">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.clone_into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/alloc/borrow.rs.html#91">Source</a><a href="#method.clone_into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/alloc/borrow/trait.ToOwned.html#method.clone_into" class="fn">clone_into</a>(&self, target: <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'>Uses borrowed data to replace owned data, usually by cloning. <a href="https://doc.rust-lang.org/1.84.0/alloc/borrow/trait.ToOwned.html#method.clone_into">Read more</a></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> |