mirror of
https://github.com/neogeek23/rusty_snek_gaem.git
synced 2026-02-04 19:18:44 +00:00
124 lines
29 KiB
HTML
124 lines
29 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="API documentation for the Rust `MmapOptions` struct in crate `memmap`."><meta name="keywords" content="rust, rustlang, rust-lang, MmapOptions"><title>memmap::MmapOptions - Rust</title><link rel="stylesheet" type="text/css" href="../normalize.css"><link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../dark.css"><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script src="../storage.js"></script></head><body class="rustdoc struct"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><p class='location'>Struct MmapOptions</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.new">new</a><a href="#method.offset">offset</a><a href="#method.len">len</a><a href="#method.stack">stack</a><a href="#method.map">map</a><a href="#method.map_exec">map_exec</a><a href="#method.map_mut">map_mut</a><a href="#method.map_copy">map_copy</a><a href="#method.map_anon">map_anon</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Clone">Clone</a><a href="#impl-Debug">Debug</a><a href="#impl-Default">Default</a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-Send">Send</a><a href="#impl-Sync">Sync</a></div></div><p class='location'><a href='index.html'>memmap</a></p><script>window.sidebarCurrent = {name: 'MmapOptions', ty: 'struct', relpath: ''};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><input class="search-input" name="search" autocomplete="off" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='in-band'>Struct <a href='index.html'>memmap</a>::<wbr><a class="struct" href=''>MmapOptions</a></span><span class='out-of-band'><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>−</span>]</a></span><a class='srclink' href='../src/memmap/lib.rs.html#30-34' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust struct'>pub struct MmapOptions { /* fields omitted */ }</pre></div><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 <code>MmapOptions::map_anon</code>, or a
|
||
file-backed memory map using one of <code>MmapOptions::map</code>, <code>MmapOptions::map_mut</code>,
|
||
<code>MmapOptions::map_exec</code>, or <code>MmapOptions::map_copy</code>.</p>
|
||
</div><h2 id='methods' class='small-section-header'>Methods<a href='#methods' class='anchor'></a></h2><h3 id='impl' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="struct" href="../memmap/struct.MmapOptions.html" title="struct memmap::MmapOptions">MmapOptions</a></code><a href='#impl' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/memmap/lib.rs.html#36-282' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.new' class="method"><span id='new.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.new' class='fnname'>new</a>() -> <a class="struct" href="../memmap/struct.MmapOptions.html" title="struct memmap::MmapOptions">MmapOptions</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/memmap/lib.rs.html#61-63' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Creates a new set of options for configuring and creating a memory map.</p>
|
||
<h1 id="example" class="section-header"><a href="#example">Example</a></h1>
|
||
<pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">memmap</span>::{<span class="ident">MmapMut</span>, <span class="ident">MmapOptions</span>};
|
||
|
||
<span class="comment">// Create a new memory map builder.</span>
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">mmap_options</span> <span class="op">=</span> <span class="ident">MmapOptions</span>::<span class="ident">new</span>();
|
||
|
||
<span class="comment">// Configure the memory map builder using option setters, then create</span>
|
||
<span class="comment">// a memory map using one of `mmap_options.map_anon`, `mmap_options.map`,</span>
|
||
<span class="comment">// `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> <span class="ident">mmap</span>: <span class="ident">MmapMut</span> <span class="op">=</span> <span class="ident">mmap_options</span>.<span class="ident">len</span>(<span class="number">36</span>).<span class="ident">map_anon</span>()<span class="question-mark">?</span>;
|
||
|
||
<span class="comment">// Use the memory map:</span>
|
||
<span class="ident">mmap</span>.<span class="ident">copy_from_slice</span>(<span class="string">b"...data to copy to the memory map..."</span>);</pre>
|
||
</div><h4 id='method.offset' class="method"><span id='offset.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.offset' class='fnname'>offset</a>(&mut self, offset: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>Self</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/memmap/lib.rs.html#89-92' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><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>
|
||
<h1 id="example-1" class="section-header"><a href="#example-1">Example</a></h1>
|
||
<pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">memmap</span>::<span class="ident">MmapOptions</span>;
|
||
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">fs</span>::<span class="ident">File</span>;
|
||
|
||
<span class="kw">let</span> <span class="ident">mmap</span> <span class="op">=</span> <span class="kw">unsafe</span> {
|
||
<span class="ident">MmapOptions</span>::<span class="ident">new</span>()
|
||
.<span class="ident">offset</span>(<span class="number">10</span>)
|
||
.<span class="ident">map</span>(<span class="kw-2">&</span><span class="ident">File</span>::<span class="ident">open</span>(<span class="string">"README.md"</span>)<span class="question-mark">?</span>)<span class="question-mark">?</span>
|
||
};
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="kw-2">&</span><span class="string">b"A Rust library for cross-platform memory mapped IO."</span>[..],
|
||
<span class="kw-2">&</span><span class="ident">mmap</span>[..<span class="number">51</span>]);</pre>
|
||
</div><h4 id='method.len' class="method"><span id='len.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.len' class='fnname'>len</a>(&mut self, len: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>Self</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/memmap/lib.rs.html#117-120' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><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>
|
||
<h1 id="example-2" class="section-header"><a href="#example-2">Example</a></h1>
|
||
<pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">memmap</span>::<span class="ident">MmapOptions</span>;
|
||
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">fs</span>::<span class="ident">File</span>;
|
||
|
||
<span class="kw">let</span> <span class="ident">mmap</span> <span class="op">=</span> <span class="kw">unsafe</span> {
|
||
<span class="ident">MmapOptions</span>::<span class="ident">new</span>()
|
||
.<span class="ident">len</span>(<span class="number">8</span>)
|
||
.<span class="ident">map</span>(<span class="kw-2">&</span><span class="ident">File</span>::<span class="ident">open</span>(<span class="string">"README.md"</span>)<span class="question-mark">?</span>)<span class="question-mark">?</span>
|
||
};
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="kw-2">&</span><span class="string">b"# memmap"</span>[..], <span class="kw-2">&</span><span class="ident">mmap</span>[..]);</pre>
|
||
</div><h4 id='method.stack' class="method"><span id='stack.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.stack' class='fnname'>stack</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>Self</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/memmap/lib.rs.html#153-156' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><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.</p>
|
||
<p>This option has no effect on file-backed memory maps.</p>
|
||
<h1 id="example-3" class="section-header"><a href="#example-3">Example</a></h1>
|
||
<pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">memmap</span>::<span class="ident">MmapOptions</span>;
|
||
|
||
<span class="kw">let</span> <span class="ident">stack</span> <span class="op">=</span> <span class="ident">MmapOptions</span>::<span class="ident">new</span>().<span class="ident">stack</span>().<span class="ident">len</span>(<span class="number">4096</span>).<span class="ident">map_anon</span>();</pre>
|
||
</div><h4 id='method.map' class="method"><span id='map.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub unsafe fn <a href='#method.map' class='fnname'>map</a>(&self, file: &<a class="struct" href="https://doc.rust-lang.org/nightly/std/fs/struct.File.html" title="struct std::fs::File">File</a>) -> <a class="type" href="https://doc.rust-lang.org/nightly/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="struct" href="../memmap/struct.Mmap.html" title="struct memmap::Mmap">Mmap</a>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/memmap/lib.rs.html#187-189' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Creates a read-only memory map backed by a file.</p>
|
||
<h1 id="errors" class="section-header"><a href="#errors">Errors</a></h1>
|
||
<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>
|
||
<h1 id="example-4" class="section-header"><a href="#example-4">Example</a></h1>
|
||
<pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">memmap</span>::<span class="ident">MmapOptions</span>;
|
||
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">fs</span>::<span class="ident">File</span>;
|
||
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">io</span>::<span class="ident">Read</span>;
|
||
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">file</span> <span class="op">=</span> <span class="ident">File</span>::<span class="ident">open</span>(<span class="string">"README.md"</span>)<span class="question-mark">?</span>;
|
||
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">contents</span> <span class="op">=</span> <span class="ident">Vec</span>::<span class="ident">new</span>();
|
||
<span class="ident">file</span>.<span class="ident">read_to_end</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">contents</span>)<span class="question-mark">?</span>;
|
||
|
||
<span class="kw">let</span> <span class="ident">mmap</span> <span class="op">=</span> <span class="kw">unsafe</span> {
|
||
<span class="ident">MmapOptions</span>::<span class="ident">new</span>().<span class="ident">map</span>(<span class="kw-2">&</span><span class="ident">file</span>)<span class="question-mark">?</span>
|
||
};
|
||
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="kw-2">&</span><span class="ident">contents</span>[..], <span class="kw-2">&</span><span class="ident">mmap</span>[..]);</pre>
|
||
</div><h4 id='method.map_exec' class="method"><span id='map_exec.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub unsafe fn <a href='#method.map_exec' class='fnname'>map_exec</a>(&self, file: &<a class="struct" href="https://doc.rust-lang.org/nightly/std/fs/struct.File.html" title="struct std::fs::File">File</a>) -> <a class="type" href="https://doc.rust-lang.org/nightly/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="struct" href="../memmap/struct.Mmap.html" title="struct memmap::Mmap">Mmap</a>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/memmap/lib.rs.html#197-200' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Creates a readable and executable memory map backed by a file.</p>
|
||
<h1 id="errors-1" class="section-header"><a href="#errors-1">Errors</a></h1>
|
||
<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><h4 id='method.map_mut' class="method"><span id='map_mut.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub unsafe fn <a href='#method.map_mut' class='fnname'>map_mut</a>(&self, file: &<a class="struct" href="https://doc.rust-lang.org/nightly/std/fs/struct.File.html" title="struct std::fs::File">File</a>) -> <a class="type" href="https://doc.rust-lang.org/nightly/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="struct" href="../memmap/struct.MmapMut.html" title="struct memmap::MmapMut">MmapMut</a>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/memmap/lib.rs.html#236-239' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Creates a writeable memory map backed by a file.</p>
|
||
<h1 id="errors-2" class="section-header"><a href="#errors-2">Errors</a></h1>
|
||
<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>
|
||
<h1 id="example-5" class="section-header"><a href="#example-5">Example</a></h1>
|
||
<pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">fs</span>::<span class="ident">OpenOptions</span>;
|
||
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">path</span>::<span class="ident">PathBuf</span>;
|
||
|
||
<span class="kw">use</span> <span class="ident">memmap</span>::<span class="ident">MmapOptions</span>;
|
||
<span class="kw">let</span> <span class="ident">path</span>: <span class="ident">PathBuf</span> <span class="op">=</span> <span class="comment">/* path to file */</span>
|
||
<span class="kw">let</span> <span class="ident">file</span> <span class="op">=</span> <span class="ident">OpenOptions</span>::<span class="ident">new</span>().<span class="ident">read</span>(<span class="bool-val">true</span>).<span class="ident">write</span>(<span class="bool-val">true</span>).<span class="ident">create</span>(<span class="bool-val">true</span>).<span class="ident">open</span>(<span class="kw-2">&</span><span class="ident">path</span>)<span class="question-mark">?</span>;
|
||
<span class="ident">file</span>.<span class="ident">set_len</span>(<span class="number">13</span>)<span class="question-mark">?</span>;
|
||
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">mmap</span> <span class="op">=</span> <span class="kw">unsafe</span> {
|
||
<span class="ident">MmapOptions</span>::<span class="ident">new</span>().<span class="ident">map_mut</span>(<span class="kw-2">&</span><span class="ident">file</span>)<span class="question-mark">?</span>
|
||
};
|
||
|
||
<span class="ident">mmap</span>.<span class="ident">copy_from_slice</span>(<span class="string">b"Hello, world!"</span>);</pre>
|
||
</div><h4 id='method.map_copy' class="method"><span id='map_copy.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub unsafe fn <a href='#method.map_copy' class='fnname'>map_copy</a>(&self, file: &<a class="struct" href="https://doc.rust-lang.org/nightly/std/fs/struct.File.html" title="struct std::fs::File">File</a>) -> <a class="type" href="https://doc.rust-lang.org/nightly/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="struct" href="../memmap/struct.MmapMut.html" title="struct memmap::MmapMut">MmapMut</a>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/memmap/lib.rs.html#266-269' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><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>
|
||
<h1 id="errors-3" class="section-header"><a href="#errors-3">Errors</a></h1>
|
||
<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>
|
||
<h1 id="example-6" class="section-header"><a href="#example-6">Example</a></h1>
|
||
<pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">memmap</span>::<span class="ident">MmapOptions</span>;
|
||
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">fs</span>::<span class="ident">File</span>;
|
||
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">io</span>::<span class="ident">Write</span>;
|
||
|
||
<span class="kw">let</span> <span class="ident">file</span> <span class="op">=</span> <span class="ident">File</span>::<span class="ident">open</span>(<span class="string">"README.md"</span>)<span class="question-mark">?</span>;
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">mmap</span> <span class="op">=</span> <span class="kw">unsafe</span> { <span class="ident">MmapOptions</span>::<span class="ident">new</span>().<span class="ident">map_copy</span>(<span class="kw-2">&</span><span class="ident">file</span>)<span class="question-mark">?</span> };
|
||
(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">mmap</span>[..]).<span class="ident">write_all</span>(<span class="string">b"Hello, world!"</span>)<span class="question-mark">?</span>;</pre>
|
||
</div><h4 id='method.map_anon' class="method"><span id='map_anon.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.map_anon' class='fnname'>map_anon</a>(&self) -> <a class="type" href="https://doc.rust-lang.org/nightly/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="struct" href="../memmap/struct.MmapMut.html" title="struct memmap::MmapMut">MmapMut</a>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/memmap/lib.rs.html#279-281' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Creates an anonymous memory map.</p>
|
||
<p>Note: the memory map length must be configured to be greater than 0 before creating an
|
||
anonymous memory map using <code>MmapOptions::len()</code>.</p>
|
||
<h1 id="errors-4" class="section-header"><a href="#errors-4">Errors</a></h1>
|
||
<p>This method returns an error when the underlying system call fails.</p>
|
||
</div></div><h2 id='implementations' class='small-section-header'>Trait Implementations<a href='#implementations' class='anchor'></a></h2><div id='implementations-list'><h3 id='impl-Clone' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="struct" href="../memmap/struct.MmapOptions.html" title="struct memmap::MmapOptions">MmapOptions</a></code><a href='#impl-Clone' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/memmap/lib.rs.html#29' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.clone' class="method"><span id='clone.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone' class='fnname'>clone</a>(&self) -> <a class="struct" href="../memmap/struct.MmapOptions.html" title="struct memmap::MmapOptions">MmapOptions</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/memmap/lib.rs.html#29' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns a copy of the value. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone">Read more</a></p>
|
||
</div><h4 id='method.clone_from' class="method"><span id='clone_from.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from' class='fnname'>clone_from</a>(&mut self, source: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Self)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><div class='since' title='Stable since Rust version 1.0.0'>1.0.0</div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/clone.rs.html#130-132' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from">Read more</a></p>
|
||
</div></div><h3 id='impl-Debug' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="../memmap/struct.MmapOptions.html" title="struct memmap::MmapOptions">MmapOptions</a></code><a href='#impl-Debug' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/memmap/lib.rs.html#29' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -> <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/memmap/lib.rs.html#29' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
|
||
</div></div><h3 id='impl-Default' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html" title="trait core::default::Default">Default</a> for <a class="struct" href="../memmap/struct.MmapOptions.html" title="struct memmap::MmapOptions">MmapOptions</a></code><a href='#impl-Default' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/memmap/lib.rs.html#29' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.default' class="method"><span id='default.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/default/trait.Default.html#tymethod.default' class='fnname'>default</a>() -> <a class="struct" href="../memmap/struct.MmapOptions.html" title="struct memmap::MmapOptions">MmapOptions</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/memmap/lib.rs.html#29' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns the "default value" for a type. <a href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html#tymethod.default">Read more</a></p>
|
||
</div></div></div><h2 id='synthetic-implementations' class='small-section-header'>Auto Trait Implementations<a href='#synthetic-implementations' class='anchor'></a></h2><div id='synthetic-implementations-list'><h3 id='impl-Send' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="../memmap/struct.MmapOptions.html" title="struct memmap::MmapOptions">MmapOptions</a></code><a href='#impl-Send' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></div><h3 id='impl-Sync' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="../memmap/struct.MmapOptions.html" title="struct memmap::MmapOptions">MmapOptions</a></code><a href='#impl-Sync' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></div></div></section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>⏎</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g. <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g. <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g. <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../";window.currentCrate = "memmap";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html> |