Module rustix::fs

Available on crate feature fs only.

Filesystem operations.

Re-exports

• pub use crate::io::FdFlags;
• pub use crate::io::fcntl_dupfd_cloexec;
• pub use crate::io::fcntl_getfd;
• pub use crate::io::fcntl_setfd;

Structs

• Access
  *_OK constants for use with accessat.
• Gid
  gid_t—A Unix group ID.
• Mode
  S_I* constants for use with openat, chmodat, and fchmod.
• OFlags
  O_* constants for use with openat.
• Timestamps
  Timestamps used by utimensat and futimens.
• Uid
  uid_t—A Unix user ID.

Enums

• FileType
  S_IF* constants for use with mknodat and Stat’s st_mode field.
• FlockOperation
  LOCK_* constants for use with flock and fcntl_lock.
• SeekFrom
  Enumeration of possible methods to seek within an I/O object.

Traits

• DirEntryExt
  Re-export types common to POSIX-ish platforms. Unix-specific extension methods for fs::DirEntry.
• FileExt
  Re-export types common to POSIX-ish platforms. Unix-specific extensions to fs::File.
• FileTypeExt
  Re-export types common to POSIX-ish platforms. Unix-specific extensions for fs::FileType.
• MetadataExt
  Re-export types common to POSIX-ish platforms. Unix-specific extensions to fs::Metadata.
• OpenOptionsExt
  Re-export types common to POSIX-ish platforms. Unix-specific extensions to fs::OpenOptions.
• StatExt
  Extension trait for accessing timestamp fields of Stat.

Functions

• access
  access(path, access)—Tests permissions for a file or directory.
• chmod
  chmod(path, mode)—Sets file or directory permissions.
• chown
  chown(path, owner, group)—Sets open file or directory ownership.
• fchmod
  fchmod(fd, mode)—Sets open file or directory permissions.
• fchown
  fchown(fd, owner, group)—Sets open file or directory ownership.
• fcntl_getfl
  fcntl(fd, F_GETFL)—Returns a file descriptor’s access mode and status.
• fcntl_setfl
  fcntl(fd, F_SETFL, flags)—Sets a file descriptor’s status.
• flock
  flock(fd, operation)—Acquire or release an advisory lock on an open file.
• fstat
  fstat(fd)—Queries metadata for an open file or directory.
• fsync
  fsync(fd)—Ensures that file data and metadata is written to the underlying storage device.
• ftruncate
  ftruncate(fd, length)—Sets the length of a file.
• futimens
  futimens(fd, times)—Sets timestamps for an open file or directory.
• is_file_read_write
  fcntl(fd, F_GETFL) & O_ACCMODE
• link
  link(old_path, new_path)—Creates a hard link.
• lstat
  lstat(path)—Queries metadata for a file or directory, without following symlinks.
• mkdir
  mkdir(path, mode)—Creates a directory.
• open
  open(path, oflags, mode)—Opens a file.
• readlink
  readlink(path)—Reads the contents of a symlink.
• rename
  rename(old_path, new_path)—Renames a file or directory.
• rmdir
  rmdir(path)—Removes a directory.
• seek
  lseek(fd, offset, whence)—Repositions a file descriptor within a file.
• stat
  stat(path)—Queries metadata for a file or directory.
• symlink
  symlink(old_path, new_path)—Creates a symlink.
• tell
  lseek(fd, 0, SEEK_CUR)—Returns the current position within a file.
• unlink
  unlink(path)—Unlinks a file.

Type Aliases

• Dev
  dev_t
• Nsecs
  A type for the tv_nsec field of Timespec.
• RawMode
  mode_t
• Secs
  A type for the tv_sec field of Timespec.
• Stat
  struct stat for use with statat and fstat.
• Timespec
  struct timespec