Struct openat::Dir

pub struct Dir(_);

A safe wrapper around directory file descriptor

Construct it either with Dir::cwd() or Dir::open(path)

Methods

impl Dir

pub fn cwd() -> Dir

Creates a directory descriptor that resolves paths relative to current workding directory (AT_FDCWD)

pub fn open<P: AsPath>(path: P) -> Result<Dir>

Open a directory descriptor at specified path

pub fn list_dir<P: AsPath>(&self, path: P) -> Result<DirIter>

List subdirectory of this dir

You can list directory itself if "." is specified as path.

pub fn sub_dir<P: AsPath>(&self, path: P) -> Result<Dir>

Open subdirectory

pub fn read_link<P: AsPath>(&self, path: P) -> Result<PathBuf>

Read link in this directory

pub fn open_file<P: AsPath>(&self, path: P) -> Result<File>

Open file for reading in this directory

pub fn write_file<P: AsPath>(&self, path: P, mode: mode_t) -> Result<File>

Open file for writing, create if necessary, truncate on open

pub fn append_file<P: AsPath>(&self, path: P, mode: mode_t) -> Result<File>

Open file for append, create if necessary

pub fn create_file<P: AsPath>(&self, path: P, mode: mode_t) -> Result<File>

Deprecated since 0.1.7

: please use write_file instead

Create file for writing (and truncate) in this directory

Deprecated alias for write_file

pub fn new_file<P: AsPath>(&self, path: P, mode: mode_t) -> Result<File>

Create file if not exists, fail if exists

This function checks existence and creates file atomically with respect to other threads and processes.

Technically it means passing O_EXCL flag to open.

pub fn update_file<P: AsPath>(&self, path: P, mode: mode_t) -> Result<File>

Open file for reading and writing without truncation, create if needed

pub fn symlink<P: AsPath, R: AsPath>(&self, path: P, value: R) -> Result<()>

Make a symlink in this directory

Note: the order of arguments differ from symlinkat

pub fn create_dir<P: AsPath>(&self, path: P, mode: mode_t) -> Result<()>

Create a subdirectory in this directory

pub fn local_rename<P: AsPath, R: AsPath>(&self, old: P, new: R) -> Result<()>

Rename a file in this directory to another name (keeping same dir)

pub fn remove_dir<P: AsPath>(&self, path: P) -> Result<()>

Remove a subdirectory in this directory

Note only empty directory may be removed

pub fn remove_file<P: AsPath>(&self, path: P) -> Result<()>

Remove a file in this directory

pub fn recover_path(&self) -> Result<PathBuf>

Get the path of this directory (if possible)

This uses symlinks in /proc/self, they sometimes may not be available so use with care.

pub fn metadata<P: AsPath>(&self, path: P) -> Result<Metadata>

Returns metadata of an entry in this directory

Trait Implementations

impl AsRawFd for Dir

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl FromRawFd for Dir

unsafe fn from_raw_fd(fd: RawFd) -> Dir

Constructs a new instance of Self from the given raw file descriptor.

impl IntoRawFd for Dir

fn into_raw_fd(self) -> RawFd

Consumes this object, returning the raw underlying file descriptor.

impl Drop for Dir

fn drop(&mut self)

Executes the destructor for this type.

impl Debug for Dir

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.