On this page
Struct std::os::fd::BorrowedFd
pub struct BorrowedFd<'fd> { /* private fields */ }
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
impl BorrowedFd<'_>
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
.
impl BorrowedFd<'_>
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
impl AsFd for BorrowedFd<'_>
impl AsRawFd for BorrowedFd<'_>
impl<'fd> Clone for BorrowedFd<'fd>
fn clone(&self) -> BorrowedFd<'fd>
fn clone_from(&mut self, source: &Self)
source
. Read more
impl Debug for BorrowedFd<'_>
fn fmt(&self, f: &mut Formatter<'_>) -> Result
impl IsTerminal for BorrowedFd<'_>
fn is_terminal(&self) -> bool
true
if the descriptor/handle refers to a terminal/tty. Read more
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
impl<T> Any for T
where
T: 'static + ?Sized,
impl<T> Borrow<T> for T
where
T: ?Sized,
impl<T> BorrowMut<T> for T
where
T: ?Sized,
impl<T> From<T> for T
fn from(t: T) -> T
Returns the argument unchanged.
impl<T, U> Into<U> for T
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> ToOwned for T
where
T: Clone,
type Owned = T
fn to_owned(&self) -> T
fn clone_into(&self, target: &mut T)
impl<T, U> TryFrom<U> for T
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 T
where
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
© 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