2018-10-28 21:14:05 -05:00

86 lines
9.2 KiB
HTML
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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 `quota` mod in crate `nix`."><meta name="keywords" content="rust, rustlang, rust-lang, quota"><title>nix::sys::quota - 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">&#9776;</div><p class='location'>Module quota</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: 'quota', 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=''>quota</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'>&#x2212;</span>]</a></span><a class='srclink' href='../../../src/nix/sys/quota.rs.html#1-276' title='goto source code'>[src]</a></span></h1><div class='docblock'><p>Set and configure disk quotas for users, groups, or projects.</p>
<h1 id="examples" class="section-header"><a href="#examples">Examples</a></h1>
<p>Enabling and setting a quota:</p>
<pre class="rust rust-example-rendered">
<span class="ident">quotactl_on</span>(<span class="ident">QuotaType</span>::<span class="ident">USRQUOTA</span>, <span class="string">&quot;/dev/sda1&quot;</span>, <span class="ident">QuotaFmt</span>::<span class="ident">QFMT_VFS_V1</span>, <span class="string">&quot;aquota.user&quot;</span>);
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">dqblk</span>: <span class="ident">Dqblk</span> <span class="op">=</span> <span class="ident">Default</span>::<span class="ident">default</span>();
<span class="ident">dqblk</span>.<span class="ident">set_blocks_hard_limit</span>(<span class="number">10000</span>);
<span class="ident">dqblk</span>.<span class="ident">set_blocks_soft_limit</span>(<span class="number">8000</span>);
<span class="ident">quotactl_set</span>(<span class="ident">QuotaType</span>::<span class="ident">USRQUOTA</span>, <span class="string">&quot;/dev/sda1&quot;</span>, <span class="number">50</span>, <span class="kw-2">&amp;</span><span class="ident">dqblk</span>, <span class="ident">QuotaValidFlags</span>::<span class="ident">QIF_BLIMITS</span>);</pre>
</div><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
<table>
<tr class=' module-item'>
<td><a class="struct" href="struct.Dqblk.html"
title='struct nix::sys::quota::Dqblk'>Dqblk</a></td>
<td class='docblock-short'>
<p>Wrapper type for <code>if_dqblk</code></p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.QuotaValidFlags.html"
title='struct nix::sys::quota::QuotaValidFlags'>QuotaValidFlags</a></td>
<td class='docblock-short'>
<p>Indicates the quota fields that are valid to read from.</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.QuotaFmt.html"
title='enum nix::sys::quota::QuotaFmt'>QuotaFmt</a></td>
<td class='docblock-short'>
<p>The type of quota format to use.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="enum" href="enum.QuotaType.html"
title='enum nix::sys::quota::QuotaType'>QuotaType</a></td>
<td class='docblock-short'>
<p>The scope of the quota.</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.quotactl_get.html"
title='fn nix::sys::quota::quotactl_get'>quotactl_get</a></td>
<td class='docblock-short'>
<p>Get disk quota limits and current usage for the given user/group id.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="fn" href="fn.quotactl_off.html"
title='fn nix::sys::quota::quotactl_off'>quotactl_off</a></td>
<td class='docblock-short'>
<p>Disable disk quotas for a block device.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="fn" href="fn.quotactl_on.html"
title='fn nix::sys::quota::quotactl_on'>quotactl_on</a></td>
<td class='docblock-short'>
<p>Turn on disk quotas for a block device.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="fn" href="fn.quotactl_set.html"
title='fn nix::sys::quota::quotactl_set'>quotactl_set</a></td>
<td class='docblock-short'>
<p>Configure quota values for the specified fields for a given user/group id.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="fn" href="fn.quotactl_sync.html"
title='fn nix::sys::quota::quotactl_sync'>quotactl_sync</a></td>
<td class='docblock-short'>
<p>Update the on-disk copy of quota usages for a filesystem.</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>&#9166;</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>