|
|
<!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` crate."><meta name="keywords" content="rust, rustlang, rust-lang, inotify"><title>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='../inotify/index.html'><div class='logo-container'><img src='../rust-logo.png' alt='logo'></div></a><p class='location'>Crate inotify</p><div class="sidebar-elems"><a id='all-types' href='all.html'><p>See all inotify's items</p></a><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#types">Type Definitions</a></li></ul></div><p class='location'></p><script>window.sidebarCurrent = {name: 'inotify', ty: 'mod', relpath: '../'};</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/inotify/lib.rs.html#1-110' title='goto source code'>[src]</a></span><span class='in-band'>Crate <a class="mod" href=''>inotify</a></span></h1><div class='docblock'><p>Idiomatic inotify wrapper for the Rust programming language</p>
|
|
|
<h1 id="about" class="section-header"><a href="#about">About</a></h1>
|
|
|
<p><a href="https://crates.io/crates/inotify">inotify-rs</a> is an idiomatic wrapper around the Linux kernel's <a href="https://en.wikipedia.org/wiki/Inotify">inotify</a> API
|
|
|
for the Rust programming language. It can be used for monitoring changes to
|
|
|
files or directories.</p>
|
|
|
<p>The <a href="struct.Inotify.html"><code>Inotify</code></a> struct is the main entry point into the API.</p>
|
|
|
<h1 id="example" class="section-header"><a href="#example">Example</a></h1>
|
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
|
|
<span class="kw">use</span> <span class="ident">inotify</span>::{
|
|
|
<span class="ident">Inotify</span>,
|
|
|
<span class="ident">WatchMask</span>,
|
|
|
};
|
|
|
|
|
|
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">inotify</span> <span class="op">=</span> <span class="ident">Inotify</span>::<span class="ident">init</span>()
|
|
|
.<span class="ident">expect</span>(<span class="string">"Error while initializing inotify instance"</span>);
|
|
|
|
|
|
<span class="comment">// Watch for modify and close events.</span>
|
|
|
<span class="ident">inotify</span>
|
|
|
.<span class="ident">add_watch</span>(
|
|
|
<span class="string">"/tmp/inotify-rs-test-file"</span>,
|
|
|
<span class="ident">WatchMask</span>::<span class="ident">MODIFY</span> <span class="op">|</span> <span class="ident">WatchMask</span>::<span class="ident">CLOSE</span>,
|
|
|
)
|
|
|
.<span class="ident">expect</span>(<span class="string">"Failed to add file watch"</span>);
|
|
|
|
|
|
<span class="comment">// Read events that were added with `add_watch` above.</span>
|
|
|
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">buffer</span> <span class="op">=</span> [<span class="number">0</span>; <span class="number">1024</span>];
|
|
|
<span class="kw">let</span> <span class="ident">events</span> <span class="op">=</span> <span class="ident">inotify</span>.<span class="ident">read_events_blocking</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">buffer</span>)
|
|
|
.<span class="ident">expect</span>(<span class="string">"Error while reading events"</span>);
|
|
|
|
|
|
<span class="kw">for</span> <span class="ident">event</span> <span class="kw">in</span> <span class="ident">events</span> {
|
|
|
<span class="comment">// Handle event</span>
|
|
|
}</pre></div>
|
|
|
<h1 id="attention-inotify-gotchas" class="section-header"><a href="#attention-inotify-gotchas">Attention: inotify gotchas</a></h1>
|
|
|
<p>inotify (as in, the Linux API, not this wrapper) has many edge cases, making
|
|
|
it hard to use correctly. This can lead to weird and hard to find bugs in
|
|
|
applications that are based on it. inotify-rs does its best to fix these
|
|
|
issues, but sometimes this would require an amount of runtime overhead that
|
|
|
is just unacceptable for a low-level wrapper such as this.</p>
|
|
|
<p>We've documented any issues that inotify-rs has inherited from inotify, as
|
|
|
far as we are aware of them. Please watch out for any further warnings
|
|
|
throughout this documentation. If you want to be on the safe side, in case
|
|
|
we have missed something, please read the <a href="http://man7.org/linux/man-pages/man7/inotify.7.html">inotify man pages</a> carefully.</p>
|
|
|
</div><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
|
|
|
<table><tr class='module-item'><td><a class="struct" href="struct.Event.html" title='inotify::Event struct'>Event</a></td><td class='docblock-short'><p>An inotify event</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="struct" href="struct.EventMask.html" title='inotify::EventMask struct'>EventMask</a></td><td class='docblock-short'><p>Indicates the type of an event</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="struct" href="struct.Events.html" title='inotify::Events struct'>Events</a></td><td class='docblock-short'><p>Iterator over inotify events</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="struct" href="struct.Inotify.html" title='inotify::Inotify struct'>Inotify</a></td><td class='docblock-short'><p>Idiomatic Rust wrapper around Linux's inotify API</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="struct" href="struct.WatchDescriptor.html" title='inotify::WatchDescriptor struct'>WatchDescriptor</a></td><td class='docblock-short'><p>Represents a watch on an inode</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="struct" href="struct.WatchMask.html" title='inotify::WatchMask struct'>WatchMask</a></td><td class='docblock-short'><p>Describes a file system watch</p>
|
|
|
</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.EventOwned.html" title='inotify::EventOwned type'>EventOwned</a></td><td class='docblock-short'><p>An owned version of <code>Event</code></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 = "inotify";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html> |
