W3cubDocs

/Rust

Struct BorrowedFd 

pub struct BorrowedFd<'fd> { /* private fields */ }
Available on Unix or HermitCore or target_os=trusty or WASI or target_os=motor only.

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

Implementations

Source
impl BorrowedFd<'_>
1.63.0 (const: 1.63.0)Source
pub 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, and it must not have the value -1.

Source
impl BorrowedFd<'_>
1.63.0Source
pub fn try_clone_to_owned(&self) -> Result<OwnedFd>
Available on neither WebAssembly nor HermitCore nor target_os=trusty nor target_os=motor.

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

Trait Implementations

1.63.0Source
impl AsFd for BorrowedFd<'_>
Source
fn as_fd(&self) -> BorrowedFd<'_>
Borrows the file descriptor. Read more
1.63.0Source
impl AsRawFd for BorrowedFd<'_>
Source
fn as_raw_fd(&self) -> RawFd
Extracts the raw file descriptor. Read more
1.63.0Source
impl<'fd> Clone for BorrowedFd<'fd>
Source
fn clone(&self) -> BorrowedFd<'fd>
Returns a duplicate of the value. Read more
1.0.0Source
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read more
1.63.0Source
impl Debug for BorrowedFd<'_>
Source
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
1.70.0Source
impl IsTerminal for BorrowedFd<'_>
Source
fn is_terminal(&self) -> bool
Returns true if the descriptor/handle refers to a terminal/tty. Read more
1.63.0Source
impl<'fd> Copy 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> 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> CloneToUninit for Twhere
    T: Clone,
Source
unsafe fn clone_to_uninit(&self, dest: *mut u8)
🔬This is a nightly-only experimental API. (clone_to_uninit #126799)
Performs copy-assignment from self to dest. 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,
Source
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>,
Source
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>,
Source
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.

© 2010 The Rust Project Developers
Licensed under the Apache License, Version 2.0 or the MIT license, at your option.
https://doc.rust-lang.org/std/os/fd/struct.BorrowedFd.html