Struct std::os::unix::io::BorrowedFd

#[repr(transparent)]
pub struct BorrowedFd<'fd> { /* private fields */ }

🔬 This is a nightly-only experimental API. (io_safety #87074)

This is supported on Unix only.

A borrowed file descriptor.

This has a lifetime parameter to tie it to the lifetime of something that owns the file descriptor.

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 an argument, it is not captured or consumed, and it never has the value -1.

Implementations

impl BorrowedFd<'_>

pub unsafe fn borrow_raw_fd(fd: RawFd) -> Self

🔬 This is a nightly-only experimental API. (io_safety #87074)

Return a BorrowedFd holding the given raw file descriptor.

Safety

The resource pointed to by fd must remain open for the duration of the returned BorrowedFd, and it must not have the value -1.

Trait Implementations

impl AsFd for BorrowedFd<'_>

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

🔬 This is a nightly-only experimental API. (io_safety #87074)

This is supported on Unix only.

Borrows the file descriptor.

impl AsRawFd for BorrowedFd<'_>

fn as_raw_fd(&self) -> RawFd

This is supported on Unix only.

Extracts the raw file descriptor.

impl<'fd> Clone for BorrowedFd<'fd>

fn clone(&self) -> BorrowedFd<'fd>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BorrowedFd<'_>

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

Formats the value using the given formatter.

impl<'fd> Copy for BorrowedFd<'fd>