Struct filedescriptor::OwnedHandle

pub struct OwnedHandle { /* private fields */ }

OwnedHandle allows managing the lifetime of the platform RawFileDescriptor type. It is exposed in the interface of this crate primarily for convenience on Windows where the system handle type is used for a variety of objects that don’t support reading and writing.

Implementations

impl OwnedHandle

pub fn new<F: IntoRawFileDescriptor>(f: F) -> Self

Create a new handle from some object that is convertible into the system RawFileDescriptor type. This consumes the parameter and replaces it with an OwnedHandle instance.

pub fn try_clone(&self) -> Result<Self>

Attempt to duplicate the underlying handle and return an OwnedHandle wrapped around the duplicate. Since the duplication requires kernel resources that may not be available, this is a potentially fallible operation. The returned handle has a separate lifetime from the source, but references the same object at the kernel level.

pub fn dup<F: AsRawFileDescriptor>(f: &F) -> Result<Self>

Attempt to duplicate the underlying handle from an object that is representable as the system RawFileDescriptor type and return an OwnedHandle wrapped around the duplicate. Since the duplication requires kernel resources that may not be available, this is a potentially fallible operation. The returned handle has a separate lifetime from the source, but references the same object at the kernel level.

Trait Implementations

impl AsRawFd for OwnedHandle

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl Debug for OwnedHandle

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

Formats the value using the given formatter.

impl Drop for OwnedHandle

fn drop(&mut self)

Executes the destructor for this type.

impl FromRawFd for OwnedHandle

unsafe fn from_raw_fd(fd: RawFd) -> Self

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

impl IntoRawFd for OwnedHandle

fn into_raw_fd(self) -> RawFd

Consumes this object, returning the raw underlying file descriptor.