Struct BorrowedFd

#[repr(transparent)]
pub struct BorrowedFd<'fd> { pub(in ::os::fd::owned) fd: NotAllOnes<RawFd>, pub(in ::os::fd::owned) _phantom: PhantomData<&'fd OwnedFd> }

A borrowed file descriptor.

This has a lifetime parameter to tie it to the lifetime of something that owns the file descriptor. For the duration of that lifetime, it is guaranteed that nobody will close 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.

This type does not have a [ToOwned][crate::borrow::ToOwned] implementation. Calling .to_owned() on a variable of this type will call it on &BorrowedFd and use Clone::clone() like ToOwned does for all types implementing Clone. The result will be descriptor borrowed under the same lifetime.

To obtain an OwnedFd, you can use BorrowedFd::try_clone_to_owned instead, but this is not supported on all platforms.

Fields

fd: NotAllOnes<RawFd>
_phantom: PhantomData<&'fd OwnedFd>

Implementations

impl BorrowedFd<'_>

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

Creates a new OwnedFd instance that shares the same underlying file description as the existing BorrowedFd instance.

impl BorrowedFd<'_>

const unsafe fn borrow_raw(fd: RawFd) -> Self

Returns 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.

Panics

Panics if the raw file descriptor has the value -1.

Trait Implementations

impl AsFd for BorrowedFd<'_>

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

impl AsRawFd for BorrowedFd<'_>

fn as_raw_fd(&self) -> RawFd

impl Debug for BorrowedFd<'_>

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

impl IsTerminal for BorrowedFd<'_>

fn is_terminal(&self) -> bool

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

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

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

impl<'fd> TrivialClone for BorrowedFd<'fd>

Auto Trait Implementations

impl<'fd> Freeze for BorrowedFd<'fd>

impl<'fd> RefUnwindSafe for BorrowedFd<'fd>

impl<'fd> Send for BorrowedFd<'fd>

impl<'fd> Sync for BorrowedFd<'fd>

impl<'fd> Unpin for BorrowedFd<'fd>

impl<'fd> UnsafeUnpin for BorrowedFd<'fd>

impl<'fd> UnwindSafe for BorrowedFd<'fd>

Blanket Implementations

impl<T> Any for BorrowedFd<'fd> where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for BorrowedFd<'fd> where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for BorrowedFd<'fd> where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> CloneToUninit for BorrowedFd<'fd> where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

impl<T> From<T> for BorrowedFd<'fd>

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Printable for BorrowedFd<'fd> where T: Copy + Debug,

impl<T> SizeHint for BorrowedFd<'fd> where T: ?Sized,

fn lower_bound(&self) -> usize
fn upper_bound(&self) -> Option<usize>

impl<T> SizedTypeProperties for BorrowedFd<'fd>

impl<T> ToOwned for BorrowedFd<'fd> where T: Clone,

type Owned = T;
fn to_owned(&self) -> T
fn clone_into(&self, target: &mut T)

impl<T, U> Into<U> for BorrowedFd<'fd> where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of [From]<T> for U chooses to do.

impl<T, U> TryFrom<U> for BorrowedFd<'fd> where U: Into<T>,

type Error = Infallible;
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for BorrowedFd<'fd> where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error;
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>