Struct FdBorrowed

1.63.0 · Source

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

Available on crate features std only.

Expand description

📁 🍃 std A borrowed file descriptor.

^📍^sys/os/fd ^{re-exported from std::os::fd ::BorrowedFd as FdBorrowed}

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

Struct FdBorrowed Copy item path

Implementations§

impl BorrowedFd<'_>

pub const unsafe fn borrow_raw(fd: i32) -> BorrowedFd<'_>

§Safety

§Panics

impl BorrowedFd<'_>

pub fn try_clone_to_owned(&self) -> Result<OwnedFd, Error> ⓘ

Trait Implementations§

impl AsFd for BorrowedFd<'_>

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

impl AsRawFd for BorrowedFd<'_>

fn as_raw_fd(&self) -> i32

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

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

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

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

impl Debug for BorrowedFd<'_>

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

impl IsTerminal for BorrowedFd<'_>

fn is_terminal(&self) -> bool

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

impl<'fd> UnwindSafe for BorrowedFd<'fd>

Blanket Implementations§

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

fn type_id(&self) -> TypeId

impl<T> AnyExt for Twhere T: Any + ?Sized,

fn type_id() -> TypeId

fn type_of(&self) -> TypeId

fn type_name(&self) -> &'static str ⓘ

fn type_is<T: 'static>(&self) -> bool

fn type_hash(&self) -> u64

fn type_hash_with<H: Hasher>(&self, hasher: H) -> u64

fn as_any_ref(&self) -> &dyn Anywhere Self: Sized,

fn as_any_mut(&mut self) -> &mut dyn Anywhere Self: Sized,

fn as_any_box(self: Box<Self>) -> Box<dyn Any>where Self: Sized,

fn downcast_ref<T: 'static>(&self) -> Option<&T> ⓘ

fn downcast_mut<T: 'static>(&mut self) -> Option<&mut T> ⓘ

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

fn borrow(&self) -> &T

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

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

impl<T> ByteSized for T

const BYTE_ALIGN: usize = _

const BYTE_SIZE: usize = _

fn byte_align(&self) -> usize

fn byte_size(&self) -> usize

fn ptr_size_ratio(&self) -> [usize; 2]

impl<T> CloneToUninit for Twhere T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Hook for T

fn hook<F>(self, f: F) -> Selfwhere F: FnOnce(&mut Self),

fn tap<F>(self, f: F) -> Selfwhere F: FnOnce(&Self),

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

fn into(self) -> U

impl<T> MemExt for Twhere T: ?Sized,

const NEEDS_DROP: bool = _

fn mem_align_of<T>() -> usize

fn mem_align_of_val(&self) -> usize

fn mem_size_of<T>() -> usize

fn mem_size_of_val(&self) -> usize

fn mem_copy(&self) -> Selfwhere Self: Copy,

fn mem_needs_drop(&self) -> bool

fn mem_drop(self)where Self: Sized,

fn mem_forget(self)where Self: Sized,

fn mem_replace(&mut self, other: Self) -> Selfwhere Self: Sized,

fn mem_take(&mut self) -> Selfwhere Self: Default,

fn mem_swap(&mut self, other: &mut Self)where Self: Sized,

unsafe fn mem_zeroed<T>() -> T

unsafe fn mem_transmute_copy<Src, Dst>(src: &Src) -> Dst

fn mem_as_bytes(&self) -> &[u8] ⓘwhere Self: Sync + Unpin,

fn mem_as_bytes_mut(&mut self) -> &mut [u8] ⓘwhere Self: Sync + Unpin,

Struct FdBorrowed

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

impl<T> AnyExt for T
where T: Any + ?Sized,

fn as_any_ref(&self) -> &dyn Any
where Self: Sized,

fn as_any_mut(&mut self) -> &mut dyn Any
where Self: Sized,

fn as_any_box(self: Box<Self>) -> Box<dyn Any>
where Self: Sized,

impl<T> Borrow<T> for T
where T: ?Sized,

impl<T> BorrowMut<T> for T
where T: ?Sized,

impl<T> CloneToUninit for T
where T: Clone,

fn hook<F>(self, f: F) -> Self
where F: FnOnce(&mut Self),

fn tap<F>(self, f: F) -> Self
where F: FnOnce(&Self),

impl<T, U> Into<U> for T
where U: From<T>,

impl<T> MemExt for T
where T: ?Sized,

fn mem_copy(&self) -> Self
where Self: Copy,

fn mem_drop(self)
where Self: Sized,

fn mem_forget(self)
where Self: Sized,

fn mem_replace(&mut self, other: Self) -> Self
where Self: Sized,

fn mem_take(&mut self) -> Self
where Self: Default,

fn mem_swap(&mut self, other: &mut Self)
where Self: Sized,

fn mem_as_bytes(&self) -> &[u8] ⓘ
where Self: Sync + Unpin,

fn mem_as_bytes_mut(&mut self) -> &mut [u8] ⓘ
where Self: Sync + Unpin,

impl<T, R> Morph<R> for T
where T: ?Sized,

fn morph<F>(self, f: F) -> R
where F: FnOnce(Self) -> R, Self: Sized,

fn morph_ref<F>(&self, f: F) -> R
where F: FnOnce(&Self) -> R,

fn morph_mut<F>(&mut self, f: F) -> R
where F: FnOnce(&mut Self) -> R,

impl<T> ToOwned for T
where T: Clone,

impl<T, U> TryFrom<U> for T
where U: Into<T>,

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,