Struct rustix::fd::BorrowedFd
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<'_>
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.
sourceimpl<'_> BorrowedFd<'_>
impl<'_> BorrowedFd<'_>
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 raw must remain open for the duration of
the returned BorrowedFd, and it must not have the value -1.
Trait Implementations
sourceimpl<'_> AsFd for BorrowedFd<'_>
impl<'_> AsFd for BorrowedFd<'_>
sourcefn as_fd(&self) -> BorrowedFd<'_>
fn as_fd(&self) -> BorrowedFd<'_>
Borrows the file descriptor. Read more
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>
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read more
sourceimpl<'_> 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 T where
T: AsFd,
impl<T> AsFilelike for T where
T: AsFd,
sourcefn as_filelike(&self) -> BorrowedFd<'_>
fn as_filelike(&self) -> BorrowedFd<'_>
Borrows the reference. Read more
sourcefn as_filelike_view<Target>(&self) -> FilelikeView<'_, Target> where
Target: FilelikeViewType,
fn as_filelike_view<Target>(&self) -> FilelikeView<'_, Target> where
Target: FilelikeViewType,
Return a borrowing view of a resource which dereferences to a &Target. Read more
sourceimpl<T> AsRawFilelike for T where
T: AsRawFd,
impl<T> AsRawFilelike for T where
T: AsRawFd,
sourcefn as_raw_filelike(&self) -> i32
fn as_raw_filelike(&self) -> i32
Returns the raw value.
sourceimpl<T> AsRawSocketlike for T where
T: AsRawFd,
impl<T> AsRawSocketlike for T where
T: AsRawFd,
sourcefn as_raw_socketlike(&self) -> i32
fn as_raw_socketlike(&self) -> i32
Returns the raw value.
sourceimpl<T> AsSocketlike for T where
T: AsFd,
impl<T> AsSocketlike for T where
T: AsFd,
sourcefn as_socketlike(&self) -> BorrowedFd<'_>
fn as_socketlike(&self) -> BorrowedFd<'_>
Borrows the reference.
sourcefn as_socketlike_view<Target>(&self) -> SocketlikeView<'_, Target> where
Target: SocketlikeViewType,
fn as_socketlike_view<Target>(&self) -> SocketlikeView<'_, Target> where
Target: SocketlikeViewType,
Return a borrowing view of a resource which dereferences to a &Target. Read more
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into)Uses borrowed data to replace owned data, usually by cloning. Read more