mirror of
https://github.com/quickwit-oss/tantivy.git
synced 2026-05-27 21:50:41 +00:00
378 lines
24 KiB
HTML
378 lines
24 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 `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></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><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="#constants">Constants</a></li><li><a href="#functions">Functions</a></li><li><a href="#types">Type Definitions</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"><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'>Module <a href='../../index.html'>nix</a>::<wbr><a href='../index.html'>sys</a>::<wbr><a class="mod" href=''>mman</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/nix/sys/mman.rs.html#1-242' title='goto source code'>[src]</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='struct nix::sys::mman::MapFlags'>MapFlags</a></td>
|
||
<td class='docblock-short'>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="struct" href="struct.MsFlags.html"
|
||
title='struct nix::sys::mman::MsFlags'>MsFlags</a></td>
|
||
<td class='docblock-short'>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="struct" href="struct.ProtFlags.html"
|
||
title='struct nix::sys::mman::ProtFlags'>ProtFlags</a></td>
|
||
<td class='docblock-short'>
|
||
|
||
</td>
|
||
</tr></table><h2 id='constants' class='section-header'><a href="#constants">Constants</a></h2>
|
||
<table>
|
||
<tr class=' module-item'>
|
||
<td><a class="constant" href="constant.MADV_DODUMP.html"
|
||
title='constant nix::sys::mman::MADV_DODUMP'>MADV_DODUMP</a></td>
|
||
<td class='docblock-short'>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="constant" href="constant.MADV_DOFORK.html"
|
||
title='constant nix::sys::mman::MADV_DOFORK'>MADV_DOFORK</a></td>
|
||
<td class='docblock-short'>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="constant" href="constant.MADV_DONTDUMP.html"
|
||
title='constant nix::sys::mman::MADV_DONTDUMP'>MADV_DONTDUMP</a></td>
|
||
<td class='docblock-short'>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="constant" href="constant.MADV_DONTFORK.html"
|
||
title='constant nix::sys::mman::MADV_DONTFORK'>MADV_DONTFORK</a></td>
|
||
<td class='docblock-short'>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="constant" href="constant.MADV_DONTNEED.html"
|
||
title='constant nix::sys::mman::MADV_DONTNEED'>MADV_DONTNEED</a></td>
|
||
<td class='docblock-short'>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="constant" href="constant.MADV_HUGEPAGE.html"
|
||
title='constant nix::sys::mman::MADV_HUGEPAGE'>MADV_HUGEPAGE</a></td>
|
||
<td class='docblock-short'>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="constant" href="constant.MADV_HWPOISON.html"
|
||
title='constant nix::sys::mman::MADV_HWPOISON'>MADV_HWPOISON</a></td>
|
||
<td class='docblock-short'>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="constant" href="constant.MADV_MERGEABLE.html"
|
||
title='constant nix::sys::mman::MADV_MERGEABLE'>MADV_MERGEABLE</a></td>
|
||
<td class='docblock-short'>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="constant" href="constant.MADV_NOHUGEPAGE.html"
|
||
title='constant nix::sys::mman::MADV_NOHUGEPAGE'>MADV_NOHUGEPAGE</a></td>
|
||
<td class='docblock-short'>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="constant" href="constant.MADV_NORMAL.html"
|
||
title='constant nix::sys::mman::MADV_NORMAL'>MADV_NORMAL</a></td>
|
||
<td class='docblock-short'>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="constant" href="constant.MADV_RANDOM.html"
|
||
title='constant nix::sys::mman::MADV_RANDOM'>MADV_RANDOM</a></td>
|
||
<td class='docblock-short'>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="constant" href="constant.MADV_REMOVE.html"
|
||
title='constant nix::sys::mman::MADV_REMOVE'>MADV_REMOVE</a></td>
|
||
<td class='docblock-short'>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="constant" href="constant.MADV_SEQUENTIAL.html"
|
||
title='constant nix::sys::mman::MADV_SEQUENTIAL'>MADV_SEQUENTIAL</a></td>
|
||
<td class='docblock-short'>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="constant" href="constant.MADV_UNMERGEABLE.html"
|
||
title='constant nix::sys::mman::MADV_UNMERGEABLE'>MADV_UNMERGEABLE</a></td>
|
||
<td class='docblock-short'>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="constant" href="constant.MADV_WILLNEED.html"
|
||
title='constant nix::sys::mman::MADV_WILLNEED'>MADV_WILLNEED</a></td>
|
||
<td class='docblock-short'>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="constant" href="constant.MAP_32BIT.html"
|
||
title='constant nix::sys::mman::MAP_32BIT'>MAP_32BIT</a></td>
|
||
<td class='docblock-short'>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="constant" href="constant.MAP_ANON.html"
|
||
title='constant nix::sys::mman::MAP_ANON'>MAP_ANON</a></td>
|
||
<td class='docblock-short'>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="constant" href="constant.MAP_ANONYMOUS.html"
|
||
title='constant nix::sys::mman::MAP_ANONYMOUS'>MAP_ANONYMOUS</a></td>
|
||
<td class='docblock-short'>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="constant" href="constant.MAP_DENYWRITE.html"
|
||
title='constant nix::sys::mman::MAP_DENYWRITE'>MAP_DENYWRITE</a></td>
|
||
<td class='docblock-short'>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="constant" href="constant.MAP_EXECUTABLE.html"
|
||
title='constant nix::sys::mman::MAP_EXECUTABLE'>MAP_EXECUTABLE</a></td>
|
||
<td class='docblock-short'>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="constant" href="constant.MAP_FAILED.html"
|
||
title='constant nix::sys::mman::MAP_FAILED'>MAP_FAILED</a></td>
|
||
<td class='docblock-short'>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="constant" href="constant.MAP_FILE.html"
|
||
title='constant nix::sys::mman::MAP_FILE'>MAP_FILE</a></td>
|
||
<td class='docblock-short'>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="constant" href="constant.MAP_FIXED.html"
|
||
title='constant nix::sys::mman::MAP_FIXED'>MAP_FIXED</a></td>
|
||
<td class='docblock-short'>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="constant" href="constant.MAP_GROWSDOWN.html"
|
||
title='constant nix::sys::mman::MAP_GROWSDOWN'>MAP_GROWSDOWN</a></td>
|
||
<td class='docblock-short'>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="constant" href="constant.MAP_HUGETLB.html"
|
||
title='constant nix::sys::mman::MAP_HUGETLB'>MAP_HUGETLB</a></td>
|
||
<td class='docblock-short'>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="constant" href="constant.MAP_LOCKED.html"
|
||
title='constant nix::sys::mman::MAP_LOCKED'>MAP_LOCKED</a></td>
|
||
<td class='docblock-short'>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="constant" href="constant.MAP_NONBLOCK.html"
|
||
title='constant nix::sys::mman::MAP_NONBLOCK'>MAP_NONBLOCK</a></td>
|
||
<td class='docblock-short'>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="constant" href="constant.MAP_NORESERVE.html"
|
||
title='constant nix::sys::mman::MAP_NORESERVE'>MAP_NORESERVE</a></td>
|
||
<td class='docblock-short'>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="constant" href="constant.MAP_POPULATE.html"
|
||
title='constant nix::sys::mman::MAP_POPULATE'>MAP_POPULATE</a></td>
|
||
<td class='docblock-short'>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="constant" href="constant.MAP_PRIVATE.html"
|
||
title='constant nix::sys::mman::MAP_PRIVATE'>MAP_PRIVATE</a></td>
|
||
<td class='docblock-short'>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="constant" href="constant.MAP_SHARED.html"
|
||
title='constant nix::sys::mman::MAP_SHARED'>MAP_SHARED</a></td>
|
||
<td class='docblock-short'>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="constant" href="constant.MAP_STACK.html"
|
||
title='constant nix::sys::mman::MAP_STACK'>MAP_STACK</a></td>
|
||
<td class='docblock-short'>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="constant" href="constant.MS_ASYNC.html"
|
||
title='constant nix::sys::mman::MS_ASYNC'>MS_ASYNC</a></td>
|
||
<td class='docblock-short'>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="constant" href="constant.MS_INVALIDATE.html"
|
||
title='constant nix::sys::mman::MS_INVALIDATE'>MS_INVALIDATE</a></td>
|
||
<td class='docblock-short'>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="constant" href="constant.MS_SYNC.html"
|
||
title='constant nix::sys::mman::MS_SYNC'>MS_SYNC</a></td>
|
||
<td class='docblock-short'>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="constant" href="constant.PROT_EXEC.html"
|
||
title='constant nix::sys::mman::PROT_EXEC'>PROT_EXEC</a></td>
|
||
<td class='docblock-short'>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="constant" href="constant.PROT_GROWSDOWN.html"
|
||
title='constant nix::sys::mman::PROT_GROWSDOWN'>PROT_GROWSDOWN</a></td>
|
||
<td class='docblock-short'>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="constant" href="constant.PROT_GROWSUP.html"
|
||
title='constant nix::sys::mman::PROT_GROWSUP'>PROT_GROWSUP</a></td>
|
||
<td class='docblock-short'>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="constant" href="constant.PROT_NONE.html"
|
||
title='constant nix::sys::mman::PROT_NONE'>PROT_NONE</a></td>
|
||
<td class='docblock-short'>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="constant" href="constant.PROT_READ.html"
|
||
title='constant nix::sys::mman::PROT_READ'>PROT_READ</a></td>
|
||
<td class='docblock-short'>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="constant" href="constant.PROT_WRITE.html"
|
||
title='constant nix::sys::mman::PROT_WRITE'>PROT_WRITE</a></td>
|
||
<td class='docblock-short'>
|
||
|
||
</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='fn nix::sys::mman::madvise'>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='fn nix::sys::mman::mlock'>mlock</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.mmap.html"
|
||
title='fn nix::sys::mman::mmap'>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.msync.html"
|
||
title='fn nix::sys::mman::msync'>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='fn nix::sys::mman::munlock'>munlock</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.munmap.html"
|
||
title='fn nix::sys::mman::munmap'>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='fn nix::sys::mman::shm_open'>shm_open</a></td>
|
||
<td class='docblock-short'>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="fn" href="fn.shm_unlink.html"
|
||
title='fn nix::sys::mman::shm_unlink'>shm_unlink</a></td>
|
||
<td class='docblock-short'>
|
||
|
||
</td>
|
||
</tr></table><h2 id='types' class='section-header'><a href="#types">Type Definitions</a></h2>
|
||
<table>
|
||
<tr class=' module-item'>
|
||
<td><a class="type" href="type.MmapAdvise.html"
|
||
title='type nix::sys::mman::MmapAdvise'>MmapAdvise</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> |