Struct atomic_write_file::Directory

pub struct Directory<'a> { /* private fields */ }

A borrowed reference to the directory containing an [AtomicWriteFile].

This can be obtained via [AtomicWriteFile::directory()]. The purpose of this struct is to allow you to obtain the directory file descriptor, without having to open it through a call to open(2).

This struct supports only two operations:

• conversion to a borrowed directory file descriptor through [AsFd::as_fd()]
• conversion to a raw directory file descriptor through [AsRawFd::as_raw_fd()]

Directory file descriptors are not available on all platforms. See [AtomicWriteFile::directory()] for more details.

Examples

use std::os::fd::AsFd;
use atomic_write_file::AtomicWriteFile;

let file = AtomicWriteFile::open("foo.txt")?;
if let Some(dir) = file.directory() {
    let borrowed_fd = dir.as_fd();
    println!("directory fd: {:?}", borrowed_fd);
}

Trait Implementations

impl<'a> AsFd for Directory<'a>

fn as_fd(&self) -> BorrowedFd<'_>

Borrows the file descriptor.

impl<'a> AsRawFd for Directory<'a>

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl<'a> Clone for Directory<'a>

fn clone(&self) -> Directory<'a>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> Debug for Directory<'a>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'a> Copy for Directory<'a>