mirror of
https://github.com/fluencelabs/wasmer
synced 2025-04-29 04:12:13 +00:00
28 lines
7.5 KiB
HTML
28 lines
7.5 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 `inotify` mod in crate `nix`."><meta name="keywords" content="rust, rustlang, rust-lang, inotify"><title>nix::sys::inotify - 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 inotify</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</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: 'inotify', 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/inotify.rs.html#1-230' 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=''>inotify</a></span></h1><div class='docblock'><p>Monitoring API for filesystem events.</p>
|
||
<p>Inotify is a Linux-only API to monitor filesystems events.</p>
|
||
<p>For more documentation, please read <a href="http://man7.org/linux/man-pages/man7/inotify.7.html">inotify(7)</a>.</p>
|
||
<h1 id="examples" class="section-header"><a href="#examples">Examples</a></h1>
|
||
<p>Monitor all events happening in directory "test":</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="comment">// We create a new inotify instance.</span>
|
||
<span class="kw">let</span> <span class="ident">instance</span> <span class="op">=</span> <span class="ident">Inotify</span>::<span class="ident">init</span>(<span class="ident">InitFlags</span>::<span class="ident">empty</span>()).<span class="ident">unwrap</span>();
|
||
|
||
<span class="comment">// We add a new watch on directory "test" for all events.</span>
|
||
<span class="kw">let</span> <span class="ident">wd</span> <span class="op">=</span> <span class="ident">instance</span>.<span class="ident">add_watch</span>(<span class="string">"test"</span>, <span class="ident">AddWatchFlags</span>::<span class="ident">IN_ALL_EVENTS</span>).<span class="ident">unwrap</span>();
|
||
|
||
<span class="kw">loop</span> {
|
||
<span class="comment">// We read from our inotify instance for events.</span>
|
||
<span class="kw">let</span> <span class="ident">events</span> <span class="op">=</span> <span class="ident">instance</span>.<span class="ident">read_events</span>().<span class="ident">unwrap</span>();
|
||
<span class="macro">println</span><span class="macro">!</span>(<span class="string">"Events: {:?}"</span>, <span class="ident">events</span>);
|
||
}</pre></div>
|
||
</div><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
|
||
<table><tr class='module-item'><td><a class="struct" href="struct.AddWatchFlags.html" title='nix::sys::inotify::AddWatchFlags struct'>AddWatchFlags</a></td><td class='docblock-short'><p>Configuration options for <a href="fn.inotify_add_watch.html"><code>inotify_add_watch</code></a>.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.InitFlags.html" title='nix::sys::inotify::InitFlags struct'>InitFlags</a></td><td class='docblock-short'><p>Configuration options for <a href="fn.inotify_init1.html"><code>inotify_init1</code></a>.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.Inotify.html" title='nix::sys::inotify::Inotify struct'>Inotify</a></td><td class='docblock-short'><p>An inotify instance. This is also a file descriptor, you can feed it to
|
||
other interfaces consuming file descriptors, epoll for example.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.InotifyEvent.html" title='nix::sys::inotify::InotifyEvent struct'>InotifyEvent</a></td><td class='docblock-short'><p>A single inotify event.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.WatchDescriptor.html" title='nix::sys::inotify::WatchDescriptor struct'>WatchDescriptor</a></td><td class='docblock-short'><p>This object is returned when you create a new watch on an inotify instance.
|
||
It is then returned as part of an event once triggered. It allows you to
|
||
know which watch triggered which event. </p>
|
||
</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> |