Struct OwnedFd

pub struct OwnedFd { /* private fields */ }

An owned file descriptor.

This closes the file descriptor on drop.

This uses repr(transparent) and has the representation of a host file descriptor, so it can be used in FFI in places where a file descriptor is passed as a consumed argument or returned as an owned value, and it never has the value -1.

Implementations

impl OwnedFd

pub const unsafe fn from_raw_fd(fd: RawFd) -> Self

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

Safety

The resource pointed to by fd must be open and suitable for assuming ownership. The resource must not require any cleanup other than close.

pub const fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

pub fn into_raw_fd(self) -> RawFd

Consumes this object, returning the raw underlying file descriptor.

Trait Implementations

impl AsFd for OwnedFd

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

Borrows the file descriptor.

impl Debug for OwnedFd

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

Formats the value using the given formatter.

impl Drop for OwnedFd

fn drop(&mut self)

Executes the destructor for this type.

impl From<File> for OwnedFd

Available on crate feature fs only.

fn from(this: File) -> Self

Converts to this type from the input type.

impl From<OwnedFd> for File

Available on crate feature fs only.

fn from(owned_fd: OwnedFd) -> Self

Converts to this type from the input type.