Struct owned_fd::OwnedFd

pub struct OwnedFd { /* fields omitted */ }

OwnedFd is an RAII wrapper around RawFd: it automatically closes on drop & provides borrow() functionality to support lifetimes & borrow checking around the use of file descriptors

Compared to using File, TcpStream, etc as a wrapper to close on drop, OwnedFd:

• allows any type of filedescriptor to be used safely
• has no overhead greater than a RawFd (no buffer, metadata, or other allocations)
• allows use of the borrow system to ensure drop (close) happens only when all users of an ownedfd have released it.

Methods

impl OwnedFd

unsafe fn from_unowned_raw(i: RawFd) -> Result<OwnedFd>

Given a raw file descriptor that may be owned by another (ie: another data structure might close it), create a Owned version that we have control over (via dup())

For taking ownership, see FromRawFd::from_raw_fd().

Unsafety:

• @i must be a valid file descriptor (of any kind)

fn dup(&self) -> Result<OwnedFd>

Duplicate this OwnedFd, and allow the error to be detected.

Clone uses this, but panics on error

fn from<T: IntoRawFd>(i: T) -> Self

Given a type that impliments IntoRawFd construct an OwnedFd.

This is safe because we assume the promises of IntoRawFd are followed.

NOTE: ideally, we'd impl this as From, but current rust doesn't allow that. Revisit when specialization stabilizes.

Methods from Deref<Target = FdRef>

Trait Implementations

impl AsRawFd for OwnedFd

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl IntoRawFd for OwnedFd

fn into_raw_fd(self) -> RawFd

Consumes this object, returning the raw underlying file descriptor.

impl FromRawFd for OwnedFd

unsafe fn from_raw_fd(fd: RawFd) -> OwnedFd

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

impl Drop for OwnedFd

fn drop(&mut self)

A method called when the value goes out of scope.

impl Clone for OwnedFd

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Borrow<FdRef> for OwnedFd

fn borrow(&self) -> &FdRef

Immutably borrows from an owned value.

impl Deref for OwnedFd

type Target = FdRef

The resulting type after dereferencing

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

The method called to dereference a value