|
|
<!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 `mman` mod in crate `nix`."><meta name="keywords" content="rust, rustlang, rust-lang, mman"><title>nix::sys::mman - Rust</title><link rel="stylesheet" type="text/css" href="../../../normalize.css"><link rel="stylesheet" type="text/css" href="../../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../../dark.css"><link rel="stylesheet" type="text/css" href="../../../light.css" id="themeStyle"><script src="../../../storage.js"></script><noscript><link rel="stylesheet" href="../../../noscript.css"></noscript><link rel="shortcut icon" href="../../../favicon.ico"><style type="text/css">#crate-search{background-image:url("../../../down-arrow.svg");}</style></head><body class="rustdoc mod"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../../../nix/index.html'><div class='logo-container'><img src='../../../rust-logo.png' alt='logo'></div></a><p class='location'>Module mman</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#functions">Functions</a></li></ul></div><p class='location'><a href='../../index.html'>nix</a>::<wbr><a href='../index.html'>sys</a></p><script>window.sidebarCurrent = {name: 'mman', ty: 'mod', 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"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><a id="settings-menu" href="../../../settings.html"><img src="../../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='out-of-band'><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>−</span>]</a></span><a class='srclink' href='../../../src/nix/sys/mman.rs.html#1-325' title='goto source code'>[src]</a></span><span class='in-band'>Module <a href='../../index.html'>nix</a>::<wbr><a href='../index.html'>sys</a>::<wbr><a class="mod" href=''>mman</a></span></h1><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
|
|
|
<table><tr class='module-item'><td><a class="struct" href="struct.MapFlags.html" title='nix::sys::mman::MapFlags struct'>MapFlags</a></td><td class='docblock-short'><p>Additional parameters for <code>mmap()</code>.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="struct" href="struct.MlockAllFlags.html" title='nix::sys::mman::MlockAllFlags struct'>MlockAllFlags</a></td><td class='docblock-short'><p>Flags for <code>mlockall</code>.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="struct" href="struct.MsFlags.html" title='nix::sys::mman::MsFlags struct'>MsFlags</a></td><td class='docblock-short'><p>Configuration flags for <code>msync</code>.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="struct" href="struct.ProtFlags.html" title='nix::sys::mman::ProtFlags struct'>ProtFlags</a></td><td class='docblock-short'><p>Desired memory protection of a memory mapping.</p>
|
|
|
</td></tr></table><h2 id='enums' class='section-header'><a href="#enums">Enums</a></h2>
|
|
|
<table><tr class='module-item'><td><a class="enum" href="enum.MmapAdvise.html" title='nix::sys::mman::MmapAdvise enum'>MmapAdvise</a></td><td class='docblock-short'><p>Usage information for a range of memory to allow for performance optimizations by the kernel.</p>
|
|
|
</td></tr></table><h2 id='functions' class='section-header'><a href="#functions">Functions</a></h2>
|
|
|
<table><tr class='module-item'><td><a class="fn" href="fn.madvise.html" title='nix::sys::mman::madvise fn'>madvise</a><a title='unsafe function' href='#'><sup>⚠</sup></a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="fn" href="fn.mlock.html" title='nix::sys::mman::mlock fn'>mlock</a><a title='unsafe function' href='#'><sup>⚠</sup></a></td><td class='docblock-short'><p>Locks all memory pages that contain part of the address range with <code>length</code> bytes starting at
|
|
|
<code>addr</code>. Locked pages never move to the swap area.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="fn" href="fn.mlockall.html" title='nix::sys::mman::mlockall fn'>mlockall</a></td><td class='docblock-short'><p>Locks all memory pages mapped into this process' address space. Locked pages never move to the
|
|
|
swap area.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="fn" href="fn.mmap.html" title='nix::sys::mman::mmap fn'>mmap</a><a title='unsafe function' href='#'><sup>⚠</sup></a></td><td class='docblock-short'><p>Calls to mmap are inherently unsafe, so they must be made in an unsafe block. Typically
|
|
|
a higher-level abstraction will hide the unsafe interactions with the mmap'd region.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="fn" href="fn.mprotect.html" title='nix::sys::mman::mprotect fn'>mprotect</a><a title='unsafe function' href='#'><sup>⚠</sup></a></td><td class='docblock-short'><p>Set protection of memory mapping.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="fn" href="fn.msync.html" title='nix::sys::mman::msync fn'>msync</a><a title='unsafe function' href='#'><sup>⚠</sup></a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="fn" href="fn.munlock.html" title='nix::sys::mman::munlock fn'>munlock</a><a title='unsafe function' href='#'><sup>⚠</sup></a></td><td class='docblock-short'><p>Unlocks all memory pages that contain part of the address range with <code>length</code> bytes starting at
|
|
|
<code>addr</code>.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="fn" href="fn.munlockall.html" title='nix::sys::mman::munlockall fn'>munlockall</a></td><td class='docblock-short'><p>Unlocks all memory pages mapped into this process' address space.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="fn" href="fn.munmap.html" title='nix::sys::mman::munmap fn'>munmap</a><a title='unsafe function' href='#'><sup>⚠</sup></a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="fn" href="fn.shm_open.html" title='nix::sys::mman::shm_open fn'>shm_open</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="fn" href="fn.shm_unlink.html" title='nix::sys::mman::shm_unlink fn'>shm_unlink</a></td><td class='docblock-short'></td></tr></table></section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>⏎</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g., <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g., <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g., <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../../../";window.currentCrate = "nix";</script><script src="../../../aliases.js"></script><script src="../../../main.js"></script><script defer src="../../../search-index.js"></script></body></html> |
