Struct FdGuard

pub struct FdGuard {
    pub(crate) fd: RawFd,
    pub(crate) close_on_drop: AtomicBool,
}

A RAII guard around a RawFd that closes it automatically on drop.

Fields

fd: RawFd

close_on_drop: AtomicBool

Implementations

impl FdGuard

pub fn should_not_close(&self)

Indicate that the wrapped file descriptor should not be closed when the guard is dropped.

This should be called in cases where ownership of the wrapped file descriptor has been “moved” out of the guard.

This is factored out into a separate function to ensure that it’s always used consistently.

Trait Implementations

impl AsFd for FdGuard

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

Borrows the file descriptor.

impl AsRawFd for FdGuard

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl Debug for FdGuard

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

Formats the value using the given formatter.

impl Deref for FdGuard

type Target = i32

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Drop for FdGuard

fn drop(&mut self)

Executes the destructor for this type.

impl FromRawFd for FdGuard

unsafe fn from_raw_fd(fd: RawFd) -> Self

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

impl IntoRawFd for FdGuard

fn into_raw_fd(self) -> RawFd

Consumes this object, returning the raw underlying file descriptor.

impl PartialEq for FdGuard

fn eq(&self, other: &FdGuard) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.