115 lines
41 KiB
HTML
115 lines
41 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 handle to a raw memory mapped buffer."><title>MmapRaw 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="#">MmapRaw</a></h2><h3><a href="#implementations">Methods</a></h3><ul class="block method"><li><a href="#method.advise" title="advise">advise</a></li><li><a href="#method.advise_range" title="advise_range">advise_range</a></li><li><a href="#method.as_mut_ptr" title="as_mut_ptr">as_mut_ptr</a></li><li><a href="#method.as_ptr" title="as_ptr">as_ptr</a></li><li><a href="#method.flush" title="flush">flush</a></li><li><a href="#method.flush_async" title="flush_async">flush_async</a></li><li><a href="#method.flush_async_range" title="flush_async_range">flush_async_range</a></li><li><a href="#method.flush_range" title="flush_range">flush_range</a></li><li><a href="#method.len" title="len">len</a></li><li><a href="#method.lock" title="lock">lock</a></li><li><a href="#method.map_raw" title="map_raw">map_raw</a></li><li><a href="#method.remap" title="remap">remap</a></li><li><a href="#method.unchecked_advise" title="unchecked_advise">unchecked_advise</a></li><li><a href="#method.unchecked_advise_range" title="unchecked_advise_range">unchecked_advise_range</a></li><li><a href="#method.unlock" title="unlock">unlock</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block trait-implementation"><li><a href="#impl-Debug-for-MmapRaw" title="Debug">Debug</a></li><li><a href="#impl-From%3CMmap%3E-for-MmapRaw" title="From<Mmap>">From<Mmap></a></li><li><a href="#impl-From%3CMmapMut%3E-for-MmapRaw" title="From<MmapMut>">From<MmapMut></a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block synthetic-implementation"><li><a href="#impl-Freeze-for-MmapRaw" title="Freeze">Freeze</a></li><li><a href="#impl-RefUnwindSafe-for-MmapRaw" title="RefUnwindSafe">RefUnwindSafe</a></li><li><a href="#impl-Send-for-MmapRaw" title="Send">Send</a></li><li><a href="#impl-Sync-for-MmapRaw" title="Sync">Sync</a></li><li><a href="#impl-Unpin-for-MmapRaw" title="Unpin">Unpin</a></li><li><a href="#impl-UnwindSafe-for-MmapRaw" 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 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">MmapRaw</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#819-821">Source</a> </span></div><pre class="rust item-decl"><code>pub struct MmapRaw { <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 handle to a raw memory mapped buffer.</p>
|
||
<p>This struct never hands out references to its interior, only raw pointers.
|
||
This can be helpful when creating shared memory maps between untrusted processes.</p>
|
||
<p>For the safety concerns that arise when converting these raw pointers to references,
|
||
see the <a href="struct.Mmap.html" title="struct memmap2::Mmap"><code>Mmap</code></a> safety documentation.</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-MmapRaw" class="impl"><a class="src rightside" href="../src/memmap2/lib.rs.html#823-1029">Source</a><a href="#impl-MmapRaw" class="anchor">§</a><h3 class="code-header">impl <a class="struct" href="struct.MmapRaw.html" title="struct memmap2::MmapRaw">MmapRaw</a></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.map_raw" class="method"><a class="src rightside" href="../src/memmap2/lib.rs.html#832-834">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>>(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 writeable memory map backed by a file.</p>
|
||
<p>This is equivalent to calling <code>MmapOptions::new().map_raw(file)</code>.</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 and write permissions.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.as_ptr" class="method"><a class="src rightside" href="../src/memmap2/lib.rs.html#843-845">Source</a><h4 class="code-header">pub fn <a href="#method.as_ptr" class="fn">as_ptr</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.pointer.html">*const </a><a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.u8.html">u8</a></h4></section></summary><div class="docblock"><p>Returns a raw pointer to the memory mapped file.</p>
|
||
<p>Before dereferencing this pointer, you have to make sure that the file has not been
|
||
truncated since the memory map was created.
|
||
Avoiding this will not introduce memory safety issues in Rust terms,
|
||
but will cause SIGBUS (or equivalent) signal.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.as_mut_ptr" class="method"><a class="src rightside" href="../src/memmap2/lib.rs.html#854-856">Source</a><h4 class="code-header">pub fn <a href="#method.as_mut_ptr" class="fn">as_mut_ptr</a>(&self) -> <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><div class="docblock"><p>Returns an unsafe mutable pointer to the memory mapped file.</p>
|
||
<p>Before dereferencing this pointer, you have to make sure that the file has not been
|
||
truncated since the memory map was created.
|
||
Avoiding this will not introduce memory safety issues in Rust terms,
|
||
but will cause SIGBUS (or equivalent) signal.</p>
|
||
</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#862-864">Source</a><h4 class="code-header">pub fn <a href="#method.len" class="fn">len</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.usize.html">usize</a></h4></section></summary><div class="docblock"><p>Returns the length in bytes of the memory map.</p>
|
||
<p>Note that truncating the file can cause the length to change (and render this value unusable).</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.flush" class="method"><a class="src rightside" href="../src/memmap2/lib.rs.html#900-903">Source</a><h4 class="code-header">pub fn <a href="#method.flush" class="fn">flush</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="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.unit.html">()</a>></h4></section></summary><div class="docblock"><p>Flushes outstanding memory map modifications to disk.</p>
|
||
<p>When this method returns with a non-error result, all outstanding changes to a file-backed
|
||
memory map are guaranteed to be durably stored. The file’s metadata (including last
|
||
modification timestamp) may not be updated.</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>std::fs::OpenOptions;
|
||
<span class="kw">use </span>std::io::Write;
|
||
<span class="kw">use </span>std::path::PathBuf;
|
||
<span class="kw">use </span>std::slice;
|
||
|
||
<span class="kw">use </span>memmap2::MmapRaw;
|
||
|
||
<span class="kw">let </span>tempdir = tempfile::tempdir()<span class="question-mark">?</span>;
|
||
<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">128</span>)<span class="question-mark">?</span>;
|
||
|
||
<span class="kw">let </span><span class="kw-2">mut </span>mmap = <span class="kw">unsafe </span>{ MmapRaw::map_raw(<span class="kw-2">&</span>file)<span class="question-mark">? </span>};
|
||
|
||
<span class="kw">let </span><span class="kw-2">mut </span>memory = <span class="kw">unsafe </span>{ slice::from_raw_parts_mut(mmap.as_mut_ptr(), <span class="number">128</span>) };
|
||
memory.write_all(<span class="string">b"Hello, world!"</span>)<span class="question-mark">?</span>;
|
||
mmap.flush()<span class="question-mark">?</span>;</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.flush_async" class="method"><a class="src rightside" href="../src/memmap2/lib.rs.html#910-913">Source</a><h4 class="code-header">pub fn <a href="#method.flush_async" class="fn">flush_async</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="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.unit.html">()</a>></h4></section></summary><div class="docblock"><p>Asynchronously flushes outstanding memory map modifications to disk.</p>
|
||
<p>This method initiates flushing modified pages to durable storage, but it will not wait for
|
||
the operation to complete before returning. The file’s metadata (including last
|
||
modification timestamp) may not be updated.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.flush_range" class="method"><a class="src rightside" href="../src/memmap2/lib.rs.html#924-926">Source</a><h4 class="code-header">pub fn <a href="#method.flush_range" class="fn">flush_range</a>(&self, offset: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.usize.html">usize</a>, len: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.usize.html">usize</a>) -> <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="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.unit.html">()</a>></h4></section></summary><div class="docblock"><p>Flushes outstanding memory map modifications in the range to disk.</p>
|
||
<p>The offset and length must be in the bounds of the memory map.</p>
|
||
<p>When this method returns with a non-error result, all outstanding changes to a file-backed
|
||
memory in the range are guaranteed to be durable stored. The file’s metadata (including
|
||
last modification timestamp) may not be updated. It is not guaranteed the only the changes
|
||
in the specified range are flushed; other outstanding changes to the memory map may be
|
||
flushed as well.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.flush_async_range" class="method"><a class="src rightside" href="../src/memmap2/lib.rs.html#937-939">Source</a><h4 class="code-header">pub fn <a href="#method.flush_async_range" class="fn">flush_async_range</a>(&self, offset: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.usize.html">usize</a>, len: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.usize.html">usize</a>) -> <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="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.unit.html">()</a>></h4></section></summary><div class="docblock"><p>Asynchronously flushes outstanding memory map modifications in the range to disk.</p>
|
||
<p>The offset and length must be in the bounds of the memory map.</p>
|
||
<p>This method initiates flushing modified pages to durable storage, but it will not wait for
|
||
the operation to complete before returning. The file’s metadata (including last
|
||
modification timestamp) may not be updated. It is not guaranteed that the only changes
|
||
flushed are those in the specified range; other outstanding changes to the memory map may
|
||
be flushed as well.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.advise" class="method"><a class="src rightside" href="../src/memmap2/lib.rs.html#947-950">Source</a><h4 class="code-header">pub fn <a href="#method.advise" class="fn">advise</a>(&self, advice: <a class="enum" href="enum.Advice.html" title="enum memmap2::Advice">Advice</a>) -> <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="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.unit.html">()</a>></h4></section></summary><div class="docblock"><p>Advise OS how this memory map will be accessed.</p>
|
||
<p>Only supported on Unix.</p>
|
||
<p>See <a href="https://man7.org/linux/man-pages/man2/madvise.2.html">madvise()</a> map page.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.unchecked_advise" class="method"><a class="src rightside" href="../src/memmap2/lib.rs.html#958-961">Source</a><h4 class="code-header">pub unsafe fn <a href="#method.unchecked_advise" class="fn">unchecked_advise</a>(&self, advice: <a class="enum" href="enum.UncheckedAdvice.html" title="enum memmap2::UncheckedAdvice">UncheckedAdvice</a>) -> <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="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.unit.html">()</a>></h4></section></summary><div class="docblock"><p>Advise OS how this memory map will be accessed.</p>
|
||
<p>Used with the <a href="enum.UncheckedAdvice.html" title="enum memmap2::UncheckedAdvice">unchecked flags</a>. Only supported on Unix.</p>
|
||
<p>See <a href="https://man7.org/linux/man-pages/man2/madvise.2.html">madvise()</a> map page.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.advise_range" class="method"><a class="src rightside" href="../src/memmap2/lib.rs.html#971-973">Source</a><h4 class="code-header">pub fn <a href="#method.advise_range" class="fn">advise_range</a>(
|
||
&self,
|
||
advice: <a class="enum" href="enum.Advice.html" title="enum memmap2::Advice">Advice</a>,
|
||
offset: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.usize.html">usize</a>,
|
||
len: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.usize.html">usize</a>,
|
||
) -> <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="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.unit.html">()</a>></h4></section></summary><div class="docblock"><p>Advise OS how this range of memory map will be accessed.</p>
|
||
<p>The offset and length must be in the bounds of the memory map.</p>
|
||
<p>Only supported on Unix.</p>
|
||
<p>See <a href="https://man7.org/linux/man-pages/man2/madvise.2.html">madvise()</a> map page.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.unchecked_advise_range" class="method"><a class="src rightside" href="../src/memmap2/lib.rs.html#983-990">Source</a><h4 class="code-header">pub unsafe fn <a href="#method.unchecked_advise_range" class="fn">unchecked_advise_range</a>(
|
||
&self,
|
||
advice: <a class="enum" href="enum.UncheckedAdvice.html" title="enum memmap2::UncheckedAdvice">UncheckedAdvice</a>,
|
||
offset: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.usize.html">usize</a>,
|
||
len: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.usize.html">usize</a>,
|
||
) -> <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="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.unit.html">()</a>></h4></section></summary><div class="docblock"><p>Advise OS how this range of memory map will be accessed.</p>
|
||
<p>Used with the <a href="enum.UncheckedAdvice.html" title="enum memmap2::UncheckedAdvice">unchecked flags</a>. Only supported on Unix.</p>
|
||
<p>The offset and length must be in the bounds of the memory map.</p>
|
||
<p>See <a href="https://man7.org/linux/man-pages/man2/madvise.2.html">madvise()</a> map page.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.lock" class="method"><a class="src rightside" href="../src/memmap2/lib.rs.html#996-998">Source</a><h4 class="code-header">pub fn <a href="#method.lock" class="fn">lock</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="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.unit.html">()</a>></h4></section></summary><div class="docblock"><p>Lock the whole memory map into RAM. Only supported on Unix.</p>
|
||
<p>See <a href="https://man7.org/linux/man-pages/man2/mlock.2.html">mlock()</a> map page.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.unlock" class="method"><a class="src rightside" href="../src/memmap2/lib.rs.html#1004-1006">Source</a><h4 class="code-header">pub fn <a href="#method.unlock" class="fn">unlock</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="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.unit.html">()</a>></h4></section></summary><div class="docblock"><p>Unlock the whole memory map. Only supported on Unix.</p>
|
||
<p>See <a href="https://man7.org/linux/man-pages/man2/munlock.2.html">munlock()</a> map page.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.remap" class="method"><a class="src rightside" href="../src/memmap2/lib.rs.html#1026-1028">Source</a><h4 class="code-header">pub unsafe fn <a href="#method.remap" class="fn">remap</a>(
|
||
&mut self,
|
||
new_len: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.usize.html">usize</a>,
|
||
options: <a class="struct" href="struct.RemapOptions.html" title="struct memmap2::RemapOptions">RemapOptions</a>,
|
||
) -> <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="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.unit.html">()</a>></h4></section></summary><div class="docblock"><p>Adjust the size of the memory mapping.</p>
|
||
<p>This will try to resize the memory mapping in place. If
|
||
<a href="struct.RemapOptions.html#method.may_move" title="method memmap2::RemapOptions::may_move"><code>RemapOptions::may_move</code></a> is specified it will move the mapping if it
|
||
could not resize in place, otherwise it will error.</p>
|
||
<p>Only supported on Linux.</p>
|
||
<p>See the <a href="https://man7.org/linux/man-pages/man2/mremap.2.html"><code>mremap(2)</code></a> man page.</p>
|
||
<h5 id="safety"><a class="doc-anchor" href="#safety">§</a>Safety</h5>
|
||
<p>Resizing the memory mapping beyond the end of the mapped file will
|
||
result in UB should you happen to access memory beyond the end of the
|
||
file.</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-MmapRaw" class="impl"><a class="src rightside" href="../src/memmap2/lib.rs.html#1031-1038">Source</a><a href="#impl-Debug-for-MmapRaw" 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.MmapRaw.html" title="struct memmap2::MmapRaw">MmapRaw</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#1032-1037">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, fmt: &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%3CMmap%3E-for-MmapRaw" class="impl"><a class="src rightside" href="../src/memmap2/lib.rs.html#1040-1044">Source</a><a href="#impl-From%3CMmap%3E-for-MmapRaw" 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.Mmap.html" title="struct memmap2::Mmap">Mmap</a>> for <a class="struct" href="struct.MmapRaw.html" title="struct memmap2::MmapRaw">MmapRaw</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/memmap2/lib.rs.html#1041-1043">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>(value: <a class="struct" href="struct.Mmap.html" title="struct memmap2::Mmap">Mmap</a>) -> Self</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%3CMmapMut%3E-for-MmapRaw" class="impl"><a class="src rightside" href="../src/memmap2/lib.rs.html#1046-1050">Source</a><a href="#impl-From%3CMmapMut%3E-for-MmapRaw" 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.MmapMut.html" title="struct memmap2::MmapMut">MmapMut</a>> for <a class="struct" href="struct.MmapRaw.html" title="struct memmap2::MmapRaw">MmapRaw</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/memmap2/lib.rs.html#1047-1049">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>(value: <a class="struct" href="struct.MmapMut.html" title="struct memmap2::MmapMut">MmapMut</a>) -> Self</h4></section></summary><div class='docblock'>Converts to this type from the input type.</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-MmapRaw" class="impl"><a href="#impl-Freeze-for-MmapRaw" 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.MmapRaw.html" title="struct memmap2::MmapRaw">MmapRaw</a></h3></section><section id="impl-RefUnwindSafe-for-MmapRaw" class="impl"><a href="#impl-RefUnwindSafe-for-MmapRaw" 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.MmapRaw.html" title="struct memmap2::MmapRaw">MmapRaw</a></h3></section><section id="impl-Send-for-MmapRaw" class="impl"><a href="#impl-Send-for-MmapRaw" 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.MmapRaw.html" title="struct memmap2::MmapRaw">MmapRaw</a></h3></section><section id="impl-Sync-for-MmapRaw" class="impl"><a href="#impl-Sync-for-MmapRaw" 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.MmapRaw.html" title="struct memmap2::MmapRaw">MmapRaw</a></h3></section><section id="impl-Unpin-for-MmapRaw" class="impl"><a href="#impl-Unpin-for-MmapRaw" 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.MmapRaw.html" title="struct memmap2::MmapRaw">MmapRaw</a></h3></section><section id="impl-UnwindSafe-for-MmapRaw" class="impl"><a href="#impl-UnwindSafe-for-MmapRaw" 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.MmapRaw.html" title="struct memmap2::MmapRaw">MmapRaw</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> |