# Struct std::os::fd::BorrowedFd

1.63.0 · source ·

    pub struct BorrowedFd<'fd> { /* private fields */ }

Expand description

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’s `.to_owned()` implementation returns another `BorrowedFd` rather than an `OwnedFd`. It just makes a trivial copy of the raw file descriptor, which is then borrowed under the same lifetime.

## Implementations§

source§

### impl BorrowedFd<'_>

const: 1.63.0 · source

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

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

source§

### impl BorrowedFd<'_>

source

#### pub 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.

## Trait Implementations§

source§

### impl AsFd for BorrowedFd<'_>

source§

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

Borrows the file descriptor. Read more
source§

### impl AsRawFd for BorrowedFd<'_>

source§

#### fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor. Read more
source§

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

source§

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

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from `source`. Read more
source§

### impl Debug for BorrowedFd<'_>

source§

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

Formats the value using the given formatter. Read more
1.70.0 · source§

### impl IsTerminal for BorrowedFd<'_>

source§

#### fn is_terminal(&self) -> bool

Returns `true` if the descriptor/handle refers to a terminal/tty. Read more
source§

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

## Auto Trait Implementations§

§

### 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> UnwindSafe for BorrowedFd<'fd>

## Blanket Implementations§

source§

### impl<T> Any for Twhere T: 'static + ?Sized,

source§

#### fn type_id(&self) -> TypeId

Gets the `TypeId` of `self`. Read more
source§

### impl<T> Borrow<T> for Twhere T: ?Sized,

source§

#### fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

### impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

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

Mutably borrows from an owned value. Read more
source§

### impl<T> From<T> for T

source§

#### fn from(t: T) -> T

Returns the argument unchanged.

source§

### impl<T, U> Into<U> for Twhere U: From<T>,

source§

#### fn into(self) -> U

Calls `U::from(self)`.

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

source§

### impl<T> ToOwned for Twhere T: Clone,

§

#### type Owned = T

The resulting type after obtaining ownership.
source§

#### fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

#### fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

### impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

#### type Error = Infallible

The type returned in the event of a conversion error.
source§

#### fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

### impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

#### type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

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

Performs the conversion.