Struct rustix::fd::BorrowedFd
1.63.0 · source · [−]#[repr(transparent)]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.
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
sourceimpl BorrowedFd<'_>
impl BorrowedFd<'_>
const: 1.63.0 · sourcepub const unsafe fn borrow_raw(fd: i32) -> BorrowedFd<'_>
pub const unsafe fn borrow_raw(fd: i32) -> BorrowedFd<'_>
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.
sourceimpl BorrowedFd<'_>
impl BorrowedFd<'_>
sourcepub fn try_clone_to_owned(&self) -> Result<OwnedFd, Error>
pub fn try_clone_to_owned(&self) -> Result<OwnedFd, Error>
Creates a new OwnedFd instance that shares the same underlying file
description as the existing BorrowedFd instance.
Trait Implementations
sourceimpl AsFd for BorrowedFd<'_>
impl AsFd for BorrowedFd<'_>
sourcefn as_fd(&self) -> BorrowedFd<'_>
fn as_fd(&self) -> BorrowedFd<'_>
sourceimpl AsRawFd for BorrowedFd<'_>
impl AsRawFd for BorrowedFd<'_>
sourceimpl<'fd> Clone for BorrowedFd<'fd>
impl<'fd> Clone for BorrowedFd<'fd>
sourcefn clone(&self) -> BorrowedFd<'fd>
fn clone(&self) -> BorrowedFd<'fd>
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moresourceimpl Debug for BorrowedFd<'_>
impl Debug for BorrowedFd<'_>
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
sourceimpl<T> AsFilelike for Twhere
T: AsFd,
impl<T> AsFilelike for Twhere
T: AsFd,
sourcefn as_filelike(&self) -> BorrowedFd<'_>
fn as_filelike(&self) -> BorrowedFd<'_>
sourcefn as_filelike_view<Target>(&self) -> FilelikeView<'_, Target>where
Target: FilelikeViewType,
fn as_filelike_view<Target>(&self) -> FilelikeView<'_, Target>where
Target: FilelikeViewType,
&Target. Read moresourceimpl<T> AsRawFilelike for Twhere
T: AsRawFd,
impl<T> AsRawFilelike for Twhere
T: AsRawFd,
sourcefn as_raw_filelike(&self) -> i32
fn as_raw_filelike(&self) -> i32
sourceimpl<T> AsRawSocketlike for Twhere
T: AsRawFd,
impl<T> AsRawSocketlike for Twhere
T: AsRawFd,
sourcefn as_raw_socketlike(&self) -> i32
fn as_raw_socketlike(&self) -> i32
sourceimpl<T> AsSocketlike for Twhere
T: AsFd,
impl<T> AsSocketlike for Twhere
T: AsFd,
sourcefn as_socketlike(&self) -> BorrowedFd<'_>
fn as_socketlike(&self) -> BorrowedFd<'_>
sourcefn as_socketlike_view<Target>(&self) -> SocketlikeView<'_, Target>where
Target: SocketlikeViewType,
fn as_socketlike_view<Target>(&self) -> SocketlikeView<'_, Target>where
Target: SocketlikeViewType,
&Target. Read more