NotAShelf/mpvrc
1
0
Fork 0
mirror of https://github.com/NotAShelf/mpvrc.git synced 2026-04-16 16:03:48 +00:00
Code Issues Projects Releases Packages Wiki Activity
mpvrc/rustix/fs/index.html

35 lines
No EOL
38 KiB
HTML
Raw 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="Filesystem operations."><title>rustix::fs - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="rustix" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.1 (e71f9a9a9 2025-01-27)" data-channel="1.84.1" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../../static.files/storage-59e33391.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.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" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../rustix/index.html">rustix</a><span class="version">0.38.42</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module fs</a></h2><h3><a href="#reexports">Module Items</a></h3><ul class="block"><li><a href="#reexports" title="Re-exports">Re-exports</a></li><li><a href="#modules" title="Modules">Modules</a></li><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#enums" title="Enums">Enums</a></li><li><a href="#constants" title="Constants">Constants</a></li><li><a href="#traits" title="Traits">Traits</a></li><li><a href="#functions" title="Functions">Functions</a></li><li><a href="#types" title="Type Aliases">Type Aliases</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="../index.html">In crate rustix</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="../index.html">rustix</a></span><h1>Module <span>fs</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/rustix/fs/mod.rs.html#1-204">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Filesystem operations.</p>
</div></details><h2 id="reexports" class="section-header">Re-exports<a href="#reexports" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name" id="reexport.FdFlags"><code>pub use crate::io::<a class="struct" href="../io/struct.FdFlags.html" title="struct rustix::io::FdFlags">FdFlags</a>;</code></div></li><li><div class="item-name" id="reexport.fcntl_dupfd_cloexec"><code>pub use crate::io::<a class="fn" href="../io/fn.fcntl_dupfd_cloexec.html" title="fn rustix::io::fcntl_dupfd_cloexec">fcntl_dupfd_cloexec</a>;</code></div></li><li><div class="item-name" id="reexport.fcntl_getfd"><code>pub use crate::io::<a class="fn" href="../io/fn.fcntl_getfd.html" title="fn rustix::io::fcntl_getfd">fcntl_getfd</a>;</code></div></li><li><div class="item-name" id="reexport.fcntl_setfd"><code>pub use crate::io::<a class="fn" href="../io/fn.fcntl_setfd.html" title="fn rustix::io::fcntl_setfd">fcntl_setfd</a>;</code></div></li></ul><h2 id="modules" class="section-header">Modules<a href="#modules" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="mod" href="inotify/index.html" title="mod rustix::fs::inotify">inotify</a></div><div class="desc docblock-short">inotify support for working with inotify objects.</div></li></ul><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.Access.html" title="struct rustix::fs::Access">Access</a></div><div class="desc docblock-short"><code>*_OK</code> constants for use with <a href="fn.accessat.html"><code>accessat</code></a>.</div></li><li><div class="item-name"><a class="struct" href="struct.AtFlags.html" title="struct rustix::fs::AtFlags">AtFlags</a></div><div class="desc docblock-short"><code>AT_*</code> constants for use with <a href="fn.openat.html" title="fn rustix::fs::openat"><code>openat</code></a>, <a href="fn.statat.html" title="fn rustix::fs::statat"><code>statat</code></a>, and other <code>*at</code>
functions.</div></li><li><div class="item-name"><a class="struct" href="struct.Dir.html" title="struct rustix::fs::Dir">Dir</a></div><div class="desc docblock-short"><code>DIR*</code></div></li><li><div class="item-name"><a class="struct" href="struct.DirEntry.html" title="struct rustix::fs::DirEntry">DirEntry</a></div><div class="desc docblock-short"><code>struct dirent</code></div></li><li><div class="item-name"><a class="struct" href="struct.FallocateFlags.html" title="struct rustix::fs::FallocateFlags">Fallocate<wbr>Flags</a></div><div class="desc docblock-short"><code>FALLOC_FL_*</code> constants for use with <a href="fn.fallocate.html" title="fn rustix::fs::fallocate"><code>fallocate</code></a>.</div></li><li><div class="item-name"><a class="struct" href="struct.Gid.html" title="struct rustix::fs::Gid">Gid</a></div><div class="desc docblock-short"><code>gid_t</code>—A Unix group ID.</div></li><li><div class="item-name"><a class="struct" href="struct.IFlags.html" title="struct rustix::fs::IFlags">IFlags</a></div><div class="desc docblock-short"><code>FS_*</code> constants for use with <a href="fn.ioctl_getflags.html" title="fn rustix::fs::ioctl_getflags"><code>ioctl_getflags</code></a>.</div></li><li><div class="item-name"><a class="struct" href="struct.MemfdFlags.html" title="struct rustix::fs::MemfdFlags">Memfd<wbr>Flags</a></div><div class="desc docblock-short"><code>MFD_*</code> constants for use with <a href="fn.memfd_create.html" title="fn rustix::fs::memfd_create"><code>memfd_create</code></a>.</div></li><li><div class="item-name"><a class="struct" href="struct.Mode.html" title="struct rustix::fs::Mode">Mode</a></div><div class="desc docblock-short"><code>S_I*</code> constants for use with <a href="fn.openat.html" title="fn rustix::fs::openat"><code>openat</code></a>, <a href="fn.chmodat.html" title="fn rustix::fs::chmodat"><code>chmodat</code></a>, and <a href="fn.fchmod.html" title="fn rustix::fs::fchmod"><code>fchmod</code></a>.</div></li><li><div class="item-name"><a class="struct" href="struct.OFlags.html" title="struct rustix::fs::OFlags">OFlags</a></div><div class="desc docblock-short"><code>O_*</code> constants for use with <a href="fn.openat.html" title="fn rustix::fs::openat"><code>openat</code></a>.</div></li><li><div class="item-name"><a class="struct" href="struct.RawDir.html" title="struct rustix::fs::RawDir">RawDir</a></div><div class="desc docblock-short">A directory iterator implemented with getdents.</div></li><li><div class="item-name"><a class="struct" href="struct.RawDirEntry.html" title="struct rustix::fs::RawDirEntry">RawDir<wbr>Entry</a></div><div class="desc docblock-short">A raw directory entry, similar to <a href="https://doc.rust-lang.org/1.84.1/std/fs/struct.DirEntry.html" title="struct std::fs::DirEntry"><code>std::fs::DirEntry</code></a>.</div></li><li><div class="item-name"><a class="struct" href="struct.RenameFlags.html" title="struct rustix::fs::RenameFlags">Rename<wbr>Flags</a></div><div class="desc docblock-short"><code>RENAME_*</code> constants for use with <a href="fn.renameat_with.html" title="fn rustix::fs::renameat_with"><code>renameat_with</code></a>.</div></li><li><div class="item-name"><a class="struct" href="struct.ResolveFlags.html" title="struct rustix::fs::ResolveFlags">Resolve<wbr>Flags</a></div><div class="desc docblock-short"><code>RESOLVE_*</code> constants for use with <a href="fn.openat2.html" title="fn rustix::fs::openat2"><code>openat2</code></a>.</div></li><li><div class="item-name"><a class="struct" href="struct.SealFlags.html" title="struct rustix::fs::SealFlags">Seal<wbr>Flags</a></div><div class="desc docblock-short"><code>F_SEAL_*</code> constants for use with <a href="fn.fcntl_add_seals.html" title="fn rustix::fs::fcntl_add_seals"><code>fcntl_add_seals</code></a> and
<a href="fn.fcntl_get_seals.html" title="fn rustix::fs::fcntl_get_seals"><code>fcntl_get_seals</code></a>.</div></li><li><div class="item-name"><a class="struct" href="struct.StatVfs.html" title="struct rustix::fs::StatVfs">StatVfs</a></div><div class="desc docblock-short"><code>struct statvfs</code> for use with <a href="fn.statvfs.html" title="fn rustix::fs::statvfs"><code>statvfs</code></a> and <a href="fn.fstatvfs.html" title="fn rustix::fs::fstatvfs"><code>fstatvfs</code></a>.</div></li><li><div class="item-name"><a class="struct" href="struct.StatVfsMountFlags.html" title="struct rustix::fs::StatVfsMountFlags">Stat<wbr>VfsMount<wbr>Flags</a></div><div class="desc docblock-short"><code>ST_*</code> constants for use with <a href="struct.StatVfs.html" title="struct rustix::fs::StatVfs"><code>StatVfs</code></a>.</div></li><li><div class="item-name"><a class="struct" href="struct.StatxFlags.html" title="struct rustix::fs::StatxFlags">Statx<wbr>Flags</a></div><div class="desc docblock-short"><code>STATX_*</code> constants for use with <a href="fn.statx.html" title="fn rustix::fs::statx"><code>statx</code></a>.</div></li><li><div class="item-name"><a class="struct" href="struct.Timestamps.html" title="struct rustix::fs::Timestamps">Timestamps</a></div><div class="desc docblock-short">Timestamps used by <a href="fn.utimensat.html" title="fn rustix::fs::utimensat"><code>utimensat</code></a> and <a href="fn.futimens.html" title="fn rustix::fs::futimens"><code>futimens</code></a>.</div></li><li><div class="item-name"><a class="struct" href="struct.Uid.html" title="struct rustix::fs::Uid">Uid</a></div><div class="desc docblock-short"><code>uid_t</code>—A Unix user ID.</div></li><li><div class="item-name"><a class="struct" href="struct.XattrFlags.html" title="struct rustix::fs::XattrFlags">Xattr<wbr>Flags</a></div><div class="desc docblock-short"><code>XATTR_*</code> constants for use with <a href="fn.setxattr.html" title="fn rustix::fs::setxattr"><code>setxattr</code></a>, and other <code>*setxattr</code>
functions.</div></li></ul><h2 id="enums" class="section-header">Enums<a href="#enums" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="enum" href="enum.Advice.html" title="enum rustix::fs::Advice">Advice</a></div><div class="desc docblock-short"><code>POSIX_FADV_*</code> constants for use with <a href="fn.fadvise.html" title="fn rustix::fs::fadvise"><code>fadvise</code></a>.</div></li><li><div class="item-name"><a class="enum" href="enum.FileType.html" title="enum rustix::fs::FileType">File<wbr>Type</a></div><div class="desc docblock-short"><code>S_IF*</code> constants for use with <a href="fn.mknodat.html" title="fn rustix::fs::mknodat"><code>mknodat</code></a> and <a href="type.Stat.html" title="type rustix::fs::Stat"><code>Stat</code></a>’s <code>st_mode</code> field.</div></li><li><div class="item-name"><a class="enum" href="enum.FlockOperation.html" title="enum rustix::fs::FlockOperation">Flock<wbr>Operation</a></div><div class="desc docblock-short"><code>LOCK_*</code> constants for use with <a href="fn.flock.html" title="fn rustix::fs::flock"><code>flock</code></a> and <a href="fn.fcntl_lock.html" title="fn rustix::fs::fcntl_lock"><code>fcntl_lock</code></a>.</div></li><li><div class="item-name"><a class="enum" href="enum.SeekFrom.html" title="enum rustix::fs::SeekFrom">Seek<wbr>From</a></div><div class="desc docblock-short">Enumeration of possible methods to seek within an I/O object.</div></li></ul><h2 id="constants" class="section-header">Constants<a href="#constants" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="constant" href="constant.ABS.html" title="constant rustix::fs::ABS">ABS</a></div><div class="desc docblock-short"><code>-EBADF</code>—A handle that requires paths to be absolute.</div></li><li><div class="item-name"><a class="constant" href="constant.CWD.html" title="constant rustix::fs::CWD">CWD</a></div><div class="desc docblock-short"><code>AT_FDCWD</code>—A handle representing the current working directory.</div></li><li><div class="item-name"><a class="constant" href="constant.NFS_SUPER_MAGIC.html" title="constant rustix::fs::NFS_SUPER_MAGIC">NFS_<wbr>SUPER_<wbr>MAGIC</a></div><div class="desc docblock-short">The filesystem magic number for NFS.</div></li><li><div class="item-name"><a class="constant" href="constant.PROC_SUPER_MAGIC.html" title="constant rustix::fs::PROC_SUPER_MAGIC">PROC_<wbr>SUPER_<wbr>MAGIC</a></div><div class="desc docblock-short">The filesystem magic number for procfs.</div></li><li><div class="item-name"><a class="constant" href="constant.UTIME_NOW.html" title="constant rustix::fs::UTIME_NOW">UTIME_<wbr>NOW</a></div><div class="desc docblock-short"><code>UTIME_NOW</code> for use with <a href="fn.utimensat.html" title="fn rustix::fs::utimensat"><code>utimensat</code></a>.</div></li><li><div class="item-name"><a class="constant" href="constant.UTIME_OMIT.html" title="constant rustix::fs::UTIME_OMIT">UTIME_<wbr>OMIT</a></div><div class="desc docblock-short"><code>UTIME_OMIT</code> for use with <a href="fn.utimensat.html" title="fn rustix::fs::utimensat"><code>utimensat</code></a>.</div></li></ul><h2 id="traits" class="section-header">Traits<a href="#traits" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="trait" href="trait.DirEntryExt.html" title="trait rustix::fs::DirEntryExt">DirEntry<wbr>Ext</a></div><div class="desc docblock-short">Re-export types common to POSIX-ish platforms.
Unix-specific extension methods for <a href="https://doc.rust-lang.org/1.84.1/std/fs/struct.DirEntry.html" title="struct std::fs::DirEntry"><code>fs::DirEntry</code></a>.</div></li><li><div class="item-name"><a class="trait" href="trait.FileExt.html" title="trait rustix::fs::FileExt">FileExt</a></div><div class="desc docblock-short">Re-export types common to POSIX-ish platforms.
Unix-specific extensions to <a href="https://doc.rust-lang.org/1.84.1/std/fs/struct.File.html" title="struct std::fs::File"><code>fs::File</code></a>.</div></li><li><div class="item-name"><a class="trait" href="trait.FileTypeExt.html" title="trait rustix::fs::FileTypeExt">File<wbr>Type<wbr>Ext</a></div><div class="desc docblock-short">Re-export types common to POSIX-ish platforms.
Unix-specific extensions for <a href="https://doc.rust-lang.org/1.84.1/std/fs/struct.FileType.html" title="struct std::fs::FileType"><code>fs::FileType</code></a>.</div></li><li><div class="item-name"><a class="trait" href="trait.MetadataExt.html" title="trait rustix::fs::MetadataExt">Metadata<wbr>Ext</a></div><div class="desc docblock-short">Re-export types common to POSIX-ish platforms.
Unix-specific extensions to <a href="https://doc.rust-lang.org/1.84.1/std/fs/struct.Metadata.html" title="struct std::fs::Metadata"><code>fs::Metadata</code></a>.</div></li><li><div class="item-name"><a class="trait" href="trait.OpenOptionsExt.html" title="trait rustix::fs::OpenOptionsExt">Open<wbr>Options<wbr>Ext</a></div><div class="desc docblock-short">Re-export types common to POSIX-ish platforms.
Unix-specific extensions to <a href="https://doc.rust-lang.org/1.84.1/std/fs/struct.OpenOptions.html" title="struct std::fs::OpenOptions"><code>fs::OpenOptions</code></a>.</div></li><li><div class="item-name"><a class="trait" href="trait.StatExt.html" title="trait rustix::fs::StatExt">StatExt</a></div><div class="desc docblock-short">Extension trait for accessing timestamp fields of <code>Stat</code>.</div></li></ul><h2 id="functions" class="section-header">Functions<a href="#functions" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="fn" href="fn.access.html" title="fn rustix::fs::access">access</a></div><div class="desc docblock-short"><code>access(path, access)</code>—Tests permissions for a file or directory.</div></li><li><div class="item-name"><a class="fn" href="fn.accessat.html" title="fn rustix::fs::accessat">accessat</a></div><div class="desc docblock-short"><code>faccessat(dirfd, path, access, flags)</code>—Tests permissions for a file or
directory.</div></li><li><div class="item-name"><a class="fn" href="fn.chmod.html" title="fn rustix::fs::chmod">chmod</a></div><div class="desc docblock-short"><code>chmod(path, mode)</code>—Sets file or directory permissions.</div></li><li><div class="item-name"><a class="fn" href="fn.chmodat.html" title="fn rustix::fs::chmodat">chmodat</a></div><div class="desc docblock-short"><code>fchmodat(dirfd, path, mode, flags)</code>—Sets file or directory permissions.</div></li><li><div class="item-name"><a class="fn" href="fn.chown.html" title="fn rustix::fs::chown">chown</a></div><div class="desc docblock-short"><code>chown(path, owner, group)</code>—Sets open file or directory ownership.</div></li><li><div class="item-name"><a class="fn" href="fn.chownat.html" title="fn rustix::fs::chownat">chownat</a></div><div class="desc docblock-short"><code>fchownat(dirfd, path, owner, group, flags)</code>—Sets file or directory
ownership.</div></li><li><div class="item-name"><a class="fn" href="fn.copy_file_range.html" title="fn rustix::fs::copy_file_range">copy_<wbr>file_<wbr>range</a></div><div class="desc docblock-short"><code>copy_file_range(fd_in, off_in, fd_out, off_out, len, 0)</code>—Copies data
from one file to another.</div></li><li><div class="item-name"><a class="fn" href="fn.cwd.html" title="fn rustix::fs::cwd">cwd</a><wbr><span class="stab deprecated" title="">Deprecated</span></div><div class="desc docblock-short">Return the value of [<code>CWD</code>].</div></li><li><div class="item-name"><a class="fn" href="fn.ext4_ioc_resize_fs.html" title="fn rustix::fs::ext4_ioc_resize_fs">ext4_<wbr>ioc_<wbr>resize_<wbr>fs</a></div><div class="desc docblock-short"><code>ioctl(fd, EXT4_IOC_RESIZE_FS, blocks)</code>—Resize ext4 filesystem on fd.</div></li><li><div class="item-name"><a class="fn" href="fn.fadvise.html" title="fn rustix::fs::fadvise">fadvise</a></div><div class="desc docblock-short"><code>posix_fadvise(fd, offset, len, advice)</code>—Declares an expected access
pattern for a file.</div></li><li><div class="item-name"><a class="fn" href="fn.fallocate.html" title="fn rustix::fs::fallocate">fallocate</a></div><div class="desc docblock-short"><code>fallocate(fd, mode, offset, len)</code>—Adjusts file allocation.</div></li><li><div class="item-name"><a class="fn" href="fn.fchmod.html" title="fn rustix::fs::fchmod">fchmod</a></div><div class="desc docblock-short"><code>fchmod(fd, mode)</code>—Sets open file or directory permissions.</div></li><li><div class="item-name"><a class="fn" href="fn.fchown.html" title="fn rustix::fs::fchown">fchown</a></div><div class="desc docblock-short"><code>fchown(fd, owner, group)</code>—Sets open file or directory ownership.</div></li><li><div class="item-name"><a class="fn" href="fn.fcntl_add_seals.html" title="fn rustix::fs::fcntl_add_seals">fcntl_<wbr>add_<wbr>seals</a></div><div class="desc docblock-short"><code>fcntl(fd, F_ADD_SEALS)</code></div></li><li><div class="item-name"><a class="fn" href="fn.fcntl_get_seals.html" title="fn rustix::fs::fcntl_get_seals">fcntl_<wbr>get_<wbr>seals</a></div><div class="desc docblock-short"><code>fcntl(fd, F_GET_SEALS)</code></div></li><li><div class="item-name"><a class="fn" href="fn.fcntl_getfl.html" title="fn rustix::fs::fcntl_getfl">fcntl_<wbr>getfl</a></div><div class="desc docblock-short"><code>fcntl(fd, F_GETFL)</code>—Returns a file descriptor’s access mode and status.</div></li><li><div class="item-name"><a class="fn" href="fn.fcntl_lock.html" title="fn rustix::fs::fcntl_lock">fcntl_<wbr>lock</a></div><div class="desc docblock-short"><code>fcntl(fd, F_SETLK)</code>—Acquire or release an <code>fcntl</code>-style lock.</div></li><li><div class="item-name"><a class="fn" href="fn.fcntl_setfl.html" title="fn rustix::fs::fcntl_setfl">fcntl_<wbr>setfl</a></div><div class="desc docblock-short"><code>fcntl(fd, F_SETFL, flags)</code>—Sets a file descriptor’s status.</div></li><li><div class="item-name"><a class="fn" href="fn.fdatasync.html" title="fn rustix::fs::fdatasync">fdatasync</a></div><div class="desc docblock-short"><code>fdatasync(fd)</code>—Ensures that file data is written to the underlying
storage device.</div></li><li><div class="item-name"><a class="fn" href="fn.fgetxattr.html" title="fn rustix::fs::fgetxattr">fgetxattr</a></div><div class="desc docblock-short"><code>fgetxattr(fd, name, value.as_ptr(), value.len())</code>—Get extended
filesystem attributes on an open file descriptor.</div></li><li><div class="item-name"><a class="fn" href="fn.flistxattr.html" title="fn rustix::fs::flistxattr">flistxattr</a></div><div class="desc docblock-short"><code>flistxattr(fd, list.as_ptr(), list.len())</code>—List extended filesystem
attributes on an open file descriptor.</div></li><li><div class="item-name"><a class="fn" href="fn.flock.html" title="fn rustix::fs::flock">flock</a></div><div class="desc docblock-short"><code>flock(fd, operation)</code>—Acquire or release an advisory lock on an open file.</div></li><li><div class="item-name"><a class="fn" href="fn.fremovexattr.html" title="fn rustix::fs::fremovexattr">fremovexattr</a></div><div class="desc docblock-short"><code>fremovexattr(fd, name)</code>—Remove an extended filesystem attribute on an
open file descriptor.</div></li><li><div class="item-name"><a class="fn" href="fn.fsetxattr.html" title="fn rustix::fs::fsetxattr">fsetxattr</a></div><div class="desc docblock-short"><code>fsetxattr(fd, name, value.as_ptr(), value.len(), flags)</code>—Set extended
filesystem attributes on an open file descriptor.</div></li><li><div class="item-name"><a class="fn" href="fn.fstat.html" title="fn rustix::fs::fstat">fstat</a></div><div class="desc docblock-short"><code>fstat(fd)</code>—Queries metadata for an open file or directory.</div></li><li><div class="item-name"><a class="fn" href="fn.fstatfs.html" title="fn rustix::fs::fstatfs">fstatfs</a></div><div class="desc docblock-short"><code>fstatfs(fd)</code>—Queries filesystem statistics for an open file or directory.</div></li><li><div class="item-name"><a class="fn" href="fn.fstatvfs.html" title="fn rustix::fs::fstatvfs">fstatvfs</a></div><div class="desc docblock-short"><code>fstatvfs(fd)</code>—Queries filesystem statistics for an open file or
directory, POSIX version.</div></li><li><div class="item-name"><a class="fn" href="fn.fsync.html" title="fn rustix::fs::fsync">fsync</a></div><div class="desc docblock-short"><code>fsync(fd)</code>—Ensures that file data and metadata is written to the
underlying storage device.</div></li><li><div class="item-name"><a class="fn" href="fn.ftruncate.html" title="fn rustix::fs::ftruncate">ftruncate</a></div><div class="desc docblock-short"><code>ftruncate(fd, length)</code>—Sets the length of a file.</div></li><li><div class="item-name"><a class="fn" href="fn.futimens.html" title="fn rustix::fs::futimens">futimens</a></div><div class="desc docblock-short"><code>futimens(fd, times)</code>—Sets timestamps for an open file or directory.</div></li><li><div class="item-name"><a class="fn" href="fn.getxattr.html" title="fn rustix::fs::getxattr">getxattr</a></div><div class="desc docblock-short"><code>getxattr(path, name, value.as_ptr(), value.len())</code>—Get extended
filesystem attributes.</div></li><li><div class="item-name"><a class="fn" href="fn.ioctl_blkpbszget.html" title="fn rustix::fs::ioctl_blkpbszget">ioctl_<wbr>blkpbszget</a></div><div class="desc docblock-short"><code>ioctl(fd, BLKPBSZGET)</code>—Returns the physical block size of a block device.</div></li><li><div class="item-name"><a class="fn" href="fn.ioctl_blksszget.html" title="fn rustix::fs::ioctl_blksszget">ioctl_<wbr>blksszget</a></div><div class="desc docblock-short"><code>ioctl(fd, BLKSSZGET)</code>—Returns the logical block size of a block device.</div></li><li><div class="item-name"><a class="fn" href="fn.ioctl_ficlone.html" title="fn rustix::fs::ioctl_ficlone">ioctl_<wbr>ficlone</a></div><div class="desc docblock-short"><code>ioctl(fd, FICLONE, src_fd)</code>—Share data between open files.</div></li><li><div class="item-name"><a class="fn" href="fn.ioctl_getflags.html" title="fn rustix::fs::ioctl_getflags">ioctl_<wbr>getflags</a></div><div class="desc docblock-short"><code>ioctl(fd, FS_IOC_GETFLAGS)</code>—Returns the <a href="https://man7.org/linux/man-pages/man2/ioctl_iflags.2.html">inode flags</a> attributes</div></li><li><div class="item-name"><a class="fn" href="fn.ioctl_setflags.html" title="fn rustix::fs::ioctl_setflags">ioctl_<wbr>setflags</a></div><div class="desc docblock-short"><code>ioctl(fd, FS_IOC_SETFLAGS)</code>—Modify the <a href="https://man7.org/linux/man-pages/man2/ioctl_iflags.2.html">inode flags</a> attributes</div></li><li><div class="item-name"><a class="fn" href="fn.is_file_read_write.html" title="fn rustix::fs::is_file_read_write">is_<wbr>file_<wbr>read_<wbr>write</a></div><div class="desc docblock-short"><code>fcntl(fd, F_GETFL) &amp; O_ACCMODE</code></div></li><li><div class="item-name"><a class="fn" href="fn.lgetxattr.html" title="fn rustix::fs::lgetxattr">lgetxattr</a></div><div class="desc docblock-short"><code>lgetxattr(path, name, value.as_ptr(), value.len())</code>—Get extended
filesystem attributes, without following symlinks in the last path
component.</div></li><li><div class="item-name"><a class="fn" href="fn.link.html" title="fn rustix::fs::link">link</a></div><div class="desc docblock-short"><code>link(old_path, new_path)</code>—Creates a hard link.</div></li><li><div class="item-name"><a class="fn" href="fn.linkat.html" title="fn rustix::fs::linkat">linkat</a></div><div class="desc docblock-short"><code>linkat(old_dirfd, old_path, new_dirfd, new_path, flags)</code>—Creates a hard
link.</div></li><li><div class="item-name"><a class="fn" href="fn.listxattr.html" title="fn rustix::fs::listxattr">listxattr</a></div><div class="desc docblock-short"><code>listxattr(path, list.as_ptr(), list.len())</code>—List extended filesystem
attributes.</div></li><li><div class="item-name"><a class="fn" href="fn.llistxattr.html" title="fn rustix::fs::llistxattr">llistxattr</a></div><div class="desc docblock-short"><code>llistxattr(path, list.as_ptr(), list.len())</code>—List extended filesystem
attributes, without following symlinks in the last path component.</div></li><li><div class="item-name"><a class="fn" href="fn.lremovexattr.html" title="fn rustix::fs::lremovexattr">lremovexattr</a></div><div class="desc docblock-short"><code>lremovexattr(path, name)</code>—Remove an extended filesystem attribute,
without following symlinks in the last path component.</div></li><li><div class="item-name"><a class="fn" href="fn.lsetxattr.html" title="fn rustix::fs::lsetxattr">lsetxattr</a></div><div class="desc docblock-short"><code>setxattr(path, name, value.as_ptr(), value.len(), flags)</code>—Set extended
filesystem attributes, without following symlinks in the last path
component.</div></li><li><div class="item-name"><a class="fn" href="fn.lstat.html" title="fn rustix::fs::lstat">lstat</a></div><div class="desc docblock-short"><code>lstat(path)</code>—Queries metadata for a file or directory, without following
symlinks.</div></li><li><div class="item-name"><a class="fn" href="fn.major.html" title="fn rustix::fs::major">major</a></div><div class="desc docblock-short"><code>major(dev)</code></div></li><li><div class="item-name"><a class="fn" href="fn.makedev.html" title="fn rustix::fs::makedev">makedev</a></div><div class="desc docblock-short"><code>makedev(maj, min)</code></div></li><li><div class="item-name"><a class="fn" href="fn.memfd_create.html" title="fn rustix::fs::memfd_create">memfd_<wbr>create</a></div><div class="desc docblock-short"><code>memfd_create(name, flags)</code></div></li><li><div class="item-name"><a class="fn" href="fn.minor.html" title="fn rustix::fs::minor">minor</a></div><div class="desc docblock-short"><code>minor(dev)</code></div></li><li><div class="item-name"><a class="fn" href="fn.mkdir.html" title="fn rustix::fs::mkdir">mkdir</a></div><div class="desc docblock-short"><code>mkdir(path, mode)</code>—Creates a directory.</div></li><li><div class="item-name"><a class="fn" href="fn.mkdirat.html" title="fn rustix::fs::mkdirat">mkdirat</a></div><div class="desc docblock-short"><code>mkdirat(fd, path, mode)</code>—Creates a directory.</div></li><li><div class="item-name"><a class="fn" href="fn.mknodat.html" title="fn rustix::fs::mknodat">mknodat</a></div><div class="desc docblock-short"><code>mknodat(dirfd, path, mode, dev)</code>—Creates special or normal files.</div></li><li><div class="item-name"><a class="fn" href="fn.open.html" title="fn rustix::fs::open">open</a></div><div class="desc docblock-short"><code>open(path, oflags, mode)</code>—Opens a file.</div></li><li><div class="item-name"><a class="fn" href="fn.openat.html" title="fn rustix::fs::openat">openat</a></div><div class="desc docblock-short"><code>openat(dirfd, path, oflags, mode)</code>—Opens a file.</div></li><li><div class="item-name"><a class="fn" href="fn.openat2.html" title="fn rustix::fs::openat2">openat2</a></div><div class="desc docblock-short"><code>openat2(dirfd, path, OpenHow { oflags, mode, resolve }, sizeof(OpenHow))</code></div></li><li><div class="item-name"><a class="fn" href="fn.readlink.html" title="fn rustix::fs::readlink">readlink</a></div><div class="desc docblock-short"><code>readlink(path)</code>—Reads the contents of a symlink.</div></li><li><div class="item-name"><a class="fn" href="fn.readlinkat.html" title="fn rustix::fs::readlinkat">readlinkat</a></div><div class="desc docblock-short"><code>readlinkat(fd, path)</code>—Reads the contents of a symlink.</div></li><li><div class="item-name"><a class="fn" href="fn.readlinkat_raw.html" title="fn rustix::fs::readlinkat_raw">readlinkat_<wbr>raw</a></div><div class="desc docblock-short"><code>readlinkat(fd, path)</code>—Reads the contents of a symlink, without
allocating.</div></li><li><div class="item-name"><a class="fn" href="fn.removexattr.html" title="fn rustix::fs::removexattr">removexattr</a></div><div class="desc docblock-short"><code>removexattr(path, name)</code>—Remove an extended filesystem attribute.</div></li><li><div class="item-name"><a class="fn" href="fn.rename.html" title="fn rustix::fs::rename">rename</a></div><div class="desc docblock-short"><code>rename(old_path, new_path)</code>—Renames a file or directory.</div></li><li><div class="item-name"><a class="fn" href="fn.renameat.html" title="fn rustix::fs::renameat">renameat</a></div><div class="desc docblock-short"><code>renameat(old_dirfd, old_path, new_dirfd, new_path)</code>—Renames a file or
directory.</div></li><li><div class="item-name"><a class="fn" href="fn.renameat_with.html" title="fn rustix::fs::renameat_with">renameat_<wbr>with</a></div><div class="desc docblock-short"><code>renameat2(old_dirfd, old_path, new_dirfd, new_path, flags)</code>—Renames a
file or directory.</div></li><li><div class="item-name"><a class="fn" href="fn.rmdir.html" title="fn rustix::fs::rmdir">rmdir</a></div><div class="desc docblock-short"><code>rmdir(path)</code>—Removes a directory.</div></li><li><div class="item-name"><a class="fn" href="fn.seek.html" title="fn rustix::fs::seek">seek</a></div><div class="desc docblock-short"><code>lseek(fd, offset, whence)</code>—Repositions a file descriptor within a file.</div></li><li><div class="item-name"><a class="fn" href="fn.sendfile.html" title="fn rustix::fs::sendfile">sendfile</a></div><div class="desc docblock-short"><code>sendfile(out_fd, in_fd, offset, count)</code></div></li><li><div class="item-name"><a class="fn" href="fn.setxattr.html" title="fn rustix::fs::setxattr">setxattr</a></div><div class="desc docblock-short"><code>setxattr(path, name, value.as_ptr(), value.len(), flags)</code>—Set extended
filesystem attributes.</div></li><li><div class="item-name"><a class="fn" href="fn.stat.html" title="fn rustix::fs::stat">stat</a></div><div class="desc docblock-short"><code>stat(path)</code>—Queries metadata for a file or directory.</div></li><li><div class="item-name"><a class="fn" href="fn.statat.html" title="fn rustix::fs::statat">statat</a></div><div class="desc docblock-short"><code>fstatat(dirfd, path, flags)</code>—Queries metadata for a file or directory.</div></li><li><div class="item-name"><a class="fn" href="fn.statfs.html" title="fn rustix::fs::statfs">statfs</a></div><div class="desc docblock-short"><code>statfs</code>—Queries filesystem metadata.</div></li><li><div class="item-name"><a class="fn" href="fn.statvfs.html" title="fn rustix::fs::statvfs">statvfs</a></div><div class="desc docblock-short"><code>statvfs</code>—Queries filesystem metadata, POSIX version.</div></li><li><div class="item-name"><a class="fn" href="fn.statx.html" title="fn rustix::fs::statx">statx</a></div><div class="desc docblock-short"><code>statx(dirfd, path, flags, mask, statxbuf)</code></div></li><li><div class="item-name"><a class="fn" href="fn.symlink.html" title="fn rustix::fs::symlink">symlink</a></div><div class="desc docblock-short"><code>symlink(old_path, new_path)</code>—Creates a symlink.</div></li><li><div class="item-name"><a class="fn" href="fn.symlinkat.html" title="fn rustix::fs::symlinkat">symlinkat</a></div><div class="desc docblock-short"><code>symlinkat(old_path, new_dirfd, new_path)</code>—Creates a symlink.</div></li><li><div class="item-name"><a class="fn" href="fn.sync.html" title="fn rustix::fs::sync">sync</a></div><div class="desc docblock-short"><code>sync</code>—Flush cached filesystem data for all filesystems.</div></li><li><div class="item-name"><a class="fn" href="fn.syncfs.html" title="fn rustix::fs::syncfs">syncfs</a></div><div class="desc docblock-short"><code>syncfs(fd)</code>—Flush cached filesystem data.</div></li><li><div class="item-name"><a class="fn" href="fn.tell.html" title="fn rustix::fs::tell">tell</a></div><div class="desc docblock-short"><code>lseek(fd, 0, SEEK_CUR)</code>—Returns the current position within a file.</div></li><li><div class="item-name"><a class="fn" href="fn.unlink.html" title="fn rustix::fs::unlink">unlink</a></div><div class="desc docblock-short"><code>unlink(path)</code>—Unlinks a file.</div></li><li><div class="item-name"><a class="fn" href="fn.unlinkat.html" title="fn rustix::fs::unlinkat">unlinkat</a></div><div class="desc docblock-short"><code>unlinkat(fd, path, flags)</code>—Unlinks a file or remove a directory.</div></li><li><div class="item-name"><a class="fn" href="fn.utimensat.html" title="fn rustix::fs::utimensat">utimensat</a></div><div class="desc docblock-short"><code>utimensat(dirfd, path, times, flags)</code>—Sets file or directory timestamps.</div></li></ul><h2 id="types" class="section-header">Type Aliases<a href="#types" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="type" href="type.Dev.html" title="type rustix::fs::Dev">Dev</a></div><div class="desc docblock-short"><code>dev_t</code></div></li><li><div class="item-name"><a class="type" href="type.FsWord.html" title="type rustix::fs::FsWord">FsWord</a></div><div class="desc docblock-short"><code>__fsword_t</code></div></li><li><div class="item-name"><a class="type" href="type.Nsecs.html" title="type rustix::fs::Nsecs">Nsecs</a></div><div class="desc docblock-short">A type for the <code>tv_sec</code> field of <a href="type.Timespec.html" title="type rustix::fs::Timespec"><code>Timespec</code></a>.</div></li><li><div class="item-name"><a class="type" href="type.RawMode.html" title="type rustix::fs::RawMode">RawMode</a></div><div class="desc docblock-short"><code>mode_t</code></div></li><li><div class="item-name"><a class="type" href="type.Secs.html" title="type rustix::fs::Secs">Secs</a></div><div class="desc docblock-short">A type for the <code>tv_sec</code> field of <a href="type.Timespec.html" title="type rustix::fs::Timespec"><code>Timespec</code></a>.</div></li><li><div class="item-name"><a class="type" href="type.Stat.html" title="type rustix::fs::Stat">Stat</a></div><div class="desc docblock-short"><code>struct stat</code> for use with <a href="fn.statat.html" title="fn rustix::fs::statat"><code>statat</code></a> and <a href="fn.fstat.html" title="fn rustix::fs::fstat"><code>fstat</code></a>.</div></li><li><div class="item-name"><a class="type" href="type.StatFs.html" title="type rustix::fs::StatFs">StatFs</a></div><div class="desc docblock-short"><code>struct statfs</code> for use with <a href="fn.statfs.html" title="fn rustix::fs::statfs"><code>statfs</code></a> and <a href="fn.fstatfs.html" title="fn rustix::fs::fstatfs"><code>fstatfs</code></a>.</div></li><li><div class="item-name"><a class="type" href="type.Statx.html" title="type rustix::fs::Statx">Statx</a></div><div class="desc docblock-short"><code>struct statx</code> for use with <a href="fn.statx.html" title="fn rustix::fs::statx"><code>statx</code></a>.</div></li><li><div class="item-name"><a class="type" href="type.StatxTimestamp.html" title="type rustix::fs::StatxTimestamp">Statx<wbr>Timestamp</a></div><div class="desc docblock-short"><code>struct statx_timestamp</code> for use with <a href="type.Statx.html" title="type rustix::fs::Statx"><code>Statx</code></a>.</div></li><li><div class="item-name"><a class="type" href="type.Timespec.html" title="type rustix::fs::Timespec">Timespec</a></div><div class="desc docblock-short"><code>struct timespec</code></div></li></ul></section></div></main></body></html>
Reference in a new issue View git blame Copy permalink