blob: 8efbb37b76304c9bfe71e8dfdd39e1f28a34837d [file] [log] [blame]
<!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="Get filesystem statistics, non-portably"><meta name="keywords" content="rust, rustlang, rust-lang, statfs"><title>nix::sys::statfs - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../../normalize.css"><link rel="stylesheet" href="../../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../../ayu.css" disabled><link rel="stylesheet" href="../../../dark.css" disabled><link rel="stylesheet" href="../../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../../storage.js"></script><script defer src="../../../main.js"></script><noscript><link rel="stylesheet" href="../../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../../favicon.svg"></head><body class="rustdoc mod"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button><a class="sidebar-logo" href="../../../nix/index.html"><div class="logo-container"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../../nix/index.html"><div class="logo-container"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">Module statfs</a></h2><div class="sidebar-elems"><section><ul class="block"><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></section></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn">Module <a href="../../index.html">nix</a>::<wbr><a href="../index.html">sys</a>::<wbr><a class="mod" href="#">statfs</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../../../src/nix/sys/statfs.rs.html#1-853">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Get filesystem statistics, non-portably</p>
<p>See <a href="../statvfs/index.html"><code>statvfs</code></a> for a portable alternative.</p>
</div></details><h2 id="structs" class="small-section-header"><a href="#structs">Structs</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.FsType.html" title="nix::sys::statfs::FsType struct">FsType</a></div><div class="item-right docblock-short">Describes the file system type as known by the operating system.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Statfs.html" title="nix::sys::statfs::Statfs struct">Statfs</a></div><div class="item-right docblock-short">Describes a mounted file system</div></div></div><h2 id="constants" class="small-section-header"><a href="#constants">Constants</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.ADFS_SUPER_MAGIC.html" title="nix::sys::statfs::ADFS_SUPER_MAGIC constant">ADFS_SUPER_MAGIC</a></div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.AFFS_SUPER_MAGIC.html" title="nix::sys::statfs::AFFS_SUPER_MAGIC constant">AFFS_SUPER_MAGIC</a></div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.AFS_SUPER_MAGIC.html" title="nix::sys::statfs::AFS_SUPER_MAGIC constant">AFS_SUPER_MAGIC</a></div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.AUTOFS_SUPER_MAGIC.html" title="nix::sys::statfs::AUTOFS_SUPER_MAGIC constant">AUTOFS_SUPER_MAGIC</a></div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.BPF_FS_MAGIC.html" title="nix::sys::statfs::BPF_FS_MAGIC constant">BPF_FS_MAGIC</a></div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.BTRFS_SUPER_MAGIC.html" title="nix::sys::statfs::BTRFS_SUPER_MAGIC constant">BTRFS_SUPER_MAGIC</a></div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.CGROUP2_SUPER_MAGIC.html" title="nix::sys::statfs::CGROUP2_SUPER_MAGIC constant">CGROUP2_SUPER_MAGIC</a></div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.CGROUP_SUPER_MAGIC.html" title="nix::sys::statfs::CGROUP_SUPER_MAGIC constant">CGROUP_SUPER_MAGIC</a></div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.CODA_SUPER_MAGIC.html" title="nix::sys::statfs::CODA_SUPER_MAGIC constant">CODA_SUPER_MAGIC</a></div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.CRAMFS_MAGIC.html" title="nix::sys::statfs::CRAMFS_MAGIC constant">CRAMFS_MAGIC</a></div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.DEBUGFS_MAGIC.html" title="nix::sys::statfs::DEBUGFS_MAGIC constant">DEBUGFS_MAGIC</a></div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.DEVPTS_SUPER_MAGIC.html" title="nix::sys::statfs::DEVPTS_SUPER_MAGIC constant">DEVPTS_SUPER_MAGIC</a></div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.ECRYPTFS_SUPER_MAGIC.html" title="nix::sys::statfs::ECRYPTFS_SUPER_MAGIC constant">ECRYPTFS_SUPER_MAGIC</a></div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.EFS_SUPER_MAGIC.html" title="nix::sys::statfs::EFS_SUPER_MAGIC constant">EFS_SUPER_MAGIC</a></div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.EXT2_SUPER_MAGIC.html" title="nix::sys::statfs::EXT2_SUPER_MAGIC constant">EXT2_SUPER_MAGIC</a></div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.EXT3_SUPER_MAGIC.html" title="nix::sys::statfs::EXT3_SUPER_MAGIC constant">EXT3_SUPER_MAGIC</a></div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.EXT4_SUPER_MAGIC.html" title="nix::sys::statfs::EXT4_SUPER_MAGIC constant">EXT4_SUPER_MAGIC</a></div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.F2FS_SUPER_MAGIC.html" title="nix::sys::statfs::F2FS_SUPER_MAGIC constant">F2FS_SUPER_MAGIC</a></div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.FUSE_SUPER_MAGIC.html" title="nix::sys::statfs::FUSE_SUPER_MAGIC constant">FUSE_SUPER_MAGIC</a></div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.FUTEXFS_SUPER_MAGIC.html" title="nix::sys::statfs::FUTEXFS_SUPER_MAGIC constant">FUTEXFS_SUPER_MAGIC</a></div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.HOSTFS_SUPER_MAGIC.html" title="nix::sys::statfs::HOSTFS_SUPER_MAGIC constant">HOSTFS_SUPER_MAGIC</a></div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.HPFS_SUPER_MAGIC.html" title="nix::sys::statfs::HPFS_SUPER_MAGIC constant">HPFS_SUPER_MAGIC</a></div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.HUGETLBFS_MAGIC.html" title="nix::sys::statfs::HUGETLBFS_MAGIC constant">HUGETLBFS_MAGIC</a></div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.ISOFS_SUPER_MAGIC.html" title="nix::sys::statfs::ISOFS_SUPER_MAGIC constant">ISOFS_SUPER_MAGIC</a></div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.JFFS2_SUPER_MAGIC.html" title="nix::sys::statfs::JFFS2_SUPER_MAGIC constant">JFFS2_SUPER_MAGIC</a></div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.MINIX2_SUPER_MAGIC.html" title="nix::sys::statfs::MINIX2_SUPER_MAGIC constant">MINIX2_SUPER_MAGIC</a></div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.MINIX2_SUPER_MAGIC2.html" title="nix::sys::statfs::MINIX2_SUPER_MAGIC2 constant">MINIX2_SUPER_MAGIC2</a></div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.MINIX3_SUPER_MAGIC.html" title="nix::sys::statfs::MINIX3_SUPER_MAGIC constant">MINIX3_SUPER_MAGIC</a></div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.MINIX_SUPER_MAGIC.html" title="nix::sys::statfs::MINIX_SUPER_MAGIC constant">MINIX_SUPER_MAGIC</a></div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.MINIX_SUPER_MAGIC2.html" title="nix::sys::statfs::MINIX_SUPER_MAGIC2 constant">MINIX_SUPER_MAGIC2</a></div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.MSDOS_SUPER_MAGIC.html" title="nix::sys::statfs::MSDOS_SUPER_MAGIC constant">MSDOS_SUPER_MAGIC</a></div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.NCP_SUPER_MAGIC.html" title="nix::sys::statfs::NCP_SUPER_MAGIC constant">NCP_SUPER_MAGIC</a></div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.NFS_SUPER_MAGIC.html" title="nix::sys::statfs::NFS_SUPER_MAGIC constant">NFS_SUPER_MAGIC</a></div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.NILFS_SUPER_MAGIC.html" title="nix::sys::statfs::NILFS_SUPER_MAGIC constant">NILFS_SUPER_MAGIC</a></div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.NSFS_MAGIC.html" title="nix::sys::statfs::NSFS_MAGIC constant">NSFS_MAGIC</a></div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.OCFS2_SUPER_MAGIC.html" title="nix::sys::statfs::OCFS2_SUPER_MAGIC constant">OCFS2_SUPER_MAGIC</a></div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.OPENPROM_SUPER_MAGIC.html" title="nix::sys::statfs::OPENPROM_SUPER_MAGIC constant">OPENPROM_SUPER_MAGIC</a></div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.OVERLAYFS_SUPER_MAGIC.html" title="nix::sys::statfs::OVERLAYFS_SUPER_MAGIC constant">OVERLAYFS_SUPER_MAGIC</a></div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.PROC_SUPER_MAGIC.html" title="nix::sys::statfs::PROC_SUPER_MAGIC constant">PROC_SUPER_MAGIC</a></div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.QNX4_SUPER_MAGIC.html" title="nix::sys::statfs::QNX4_SUPER_MAGIC constant">QNX4_SUPER_MAGIC</a></div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.QNX6_SUPER_MAGIC.html" title="nix::sys::statfs::QNX6_SUPER_MAGIC constant">QNX6_SUPER_MAGIC</a></div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.RDTGROUP_SUPER_MAGIC.html" title="nix::sys::statfs::RDTGROUP_SUPER_MAGIC constant">RDTGROUP_SUPER_MAGIC</a></div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.REISERFS_SUPER_MAGIC.html" title="nix::sys::statfs::REISERFS_SUPER_MAGIC constant">REISERFS_SUPER_MAGIC</a></div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.SECURITYFS_MAGIC.html" title="nix::sys::statfs::SECURITYFS_MAGIC constant">SECURITYFS_MAGIC</a></div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.SELINUX_MAGIC.html" title="nix::sys::statfs::SELINUX_MAGIC constant">SELINUX_MAGIC</a></div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.SMACK_MAGIC.html" title="nix::sys::statfs::SMACK_MAGIC constant">SMACK_MAGIC</a></div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.SMB_SUPER_MAGIC.html" title="nix::sys::statfs::SMB_SUPER_MAGIC constant">SMB_SUPER_MAGIC</a></div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.SYSFS_MAGIC.html" title="nix::sys::statfs::SYSFS_MAGIC constant">SYSFS_MAGIC</a></div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.TMPFS_MAGIC.html" title="nix::sys::statfs::TMPFS_MAGIC constant">TMPFS_MAGIC</a></div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.TRACEFS_MAGIC.html" title="nix::sys::statfs::TRACEFS_MAGIC constant">TRACEFS_MAGIC</a></div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.UDF_SUPER_MAGIC.html" title="nix::sys::statfs::UDF_SUPER_MAGIC constant">UDF_SUPER_MAGIC</a></div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.USBDEVICE_SUPER_MAGIC.html" title="nix::sys::statfs::USBDEVICE_SUPER_MAGIC constant">USBDEVICE_SUPER_MAGIC</a></div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.XENFS_SUPER_MAGIC.html" title="nix::sys::statfs::XENFS_SUPER_MAGIC constant">XENFS_SUPER_MAGIC</a></div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.XFS_SUPER_MAGIC.html" title="nix::sys::statfs::XFS_SUPER_MAGIC constant">XFS_SUPER_MAGIC</a></div></div></div><h2 id="functions" class="small-section-header"><a href="#functions">Functions</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.fstatfs.html" title="nix::sys::statfs::fstatfs fn">fstatfs</a></div><div class="item-right docblock-short">Describes a mounted file system.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.statfs.html" title="nix::sys::statfs::statfs fn">statfs</a></div><div class="item-right docblock-short">Describes a mounted file system.</div></div></div><h2 id="types" class="small-section-header"><a href="#types">Type Definitions</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="type" href="type.fsid_t.html" title="nix::sys::statfs::fsid_t type">fsid_t</a></div><div class="item-right docblock-short">Identifies a mounted file system</div></div></div></section></div></main><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="nix" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>