Struct rustix::fd::OwnedFd

1.63.0 · source ·

pub struct OwnedFd { /* private fields */ }

Expand description

An owned file descriptor.

This closes the file descriptor on drop.

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 a consumed argument or returned as an owned value, and it never has the value -1.

Implementations

impl OwnedFd

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

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

Trait Implementations

impl AsFd for OwnedFd

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

Borrows the file descriptor. Read more

impl AsRawFd for OwnedFd

fn as_raw_fd(&self) -> i32

Extracts the raw file descriptor. Read more

impl Debug for OwnedFd

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

Formats the value using the given formatter. Read more

impl Drop for OwnedFd

fn drop(&mut self)

Executes the destructor for this type. Read more

impl From<ChildStderr> for OwnedFd

fn from(child_stderr: ChildStderr) -> OwnedFd

Converts to this type from the input type.

impl From<ChildStdin> for OwnedFd

fn from(child_stdin: ChildStdin) -> OwnedFd

Converts to this type from the input type.

impl From<ChildStdout> for OwnedFd

fn from(child_stdout: ChildStdout) -> OwnedFd

Converts to this type from the input type.

impl From<File> for OwnedFd

fn from(file: File) -> OwnedFd

Converts to this type from the input type.

impl From<TcpListener> for OwnedFd

fn from(tcp_listener: TcpListener) -> OwnedFd

Converts to this type from the input type.

impl From<TcpStream> for OwnedFd

fn from(tcp_stream: TcpStream) -> OwnedFd

Converts to this type from the input type.

impl From<UdpSocket> for OwnedFd

fn from(udp_socket: UdpSocket) -> OwnedFd

Converts to this type from the input type.

impl From<UnixDatagram> for OwnedFd

fn from(unix_datagram: UnixDatagram) -> OwnedFd

Converts to this type from the input type.

impl From<UnixListener> for OwnedFd

fn from(listener: UnixListener) -> OwnedFd

Converts to this type from the input type.

impl From<UnixStream> for OwnedFd

fn from(unix_stream: UnixStream) -> OwnedFd

Converts to this type from the input type.

impl FromRawFd for OwnedFd

unsafe fn from_raw_fd(fd: i32) -> OwnedFd

Constructs a new instance of Self from the given raw file descriptor.

Safety

The resource pointed to by fd must be open and suitable for assuming ownership. The resource must not require any cleanup other than close.

impl IntoRawFd for OwnedFd

fn into_raw_fd(self) -> i32

Consumes this object, returning the raw underlying file descriptor. Read more

impl IsTerminal for OwnedFd

fn is_terminal(&self) -> bool

🔬This is a nightly-only experimental API. (is_terminal)

Returns true if the descriptor/handle refers to a terminal/tty. Read more

impl FilelikeViewType for OwnedFd

Auto Trait Implementations

impl RefUnwindSafe for OwnedFd

impl Send for OwnedFd

impl Sync for OwnedFd

impl Unpin for OwnedFd

impl UnwindSafe for OwnedFd

Blanket Implementations

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> AsFilelike for Twhere
T: AsFd,

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

Borrows the reference. Read more

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

impl<T> AsRawFilelike for Twhere
T: AsRawFd,

fn as_raw_filelike(&self) -> i32

Returns the raw value.

impl<T> AsRawSocketlike for Twhere
T: AsRawFd,

fn as_raw_socketlike(&self) -> i32

Returns the raw value.

impl<T> AsSocketlike for Twhere
T: AsFd,

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

Borrows the reference.

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

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> FromFd for Twhere
T: From<OwnedFd>,

fn from_fd(owned_fd: OwnedFd) -> T

👎Deprecated since 1.0.0: FromFd::from_fd is replaced by From<OwnedFd>::from

Constructs a new instance of Self from the given file descriptor. Read more

fn from_into_fd<Owned>(into_owned: Owned) -> Selfwhere
Owned: Into<OwnedFd>,
Self: Sized + From<OwnedFd>,

Constructs a new instance of Self from the given file descriptor converted from into_owned. Read more

impl<T> FromFilelike for Twhere
T: From<OwnedFd>,

fn from_filelike(owned: OwnedFd) -> T

Constructs a new instance of Self from the given filelike object. Read more

fn from_into_filelike<Owned>(owned: Owned) -> Twhere
Owned: IntoFilelike,

Constructs a new instance of Self from the given filelike object converted from into_owned. Read more

impl<T> FromRawFilelike for Twhere
T: FromRawFd,

unsafe fn from_raw_filelike(raw: i32) -> T

Constructs Self from the raw value. Read more

impl<T> FromRawSocketlike for Twhere
T: FromRawFd,

unsafe fn from_raw_socketlike(raw: i32) -> T

Constructs Self from the raw value. Read more

impl<T> FromSocketlike for Twhere
T: From<OwnedFd>,

fn from_socketlike(owned: OwnedFd) -> T

Constructs a new instance of Self from the given socketlike object.

fn from_into_socketlike<Owned>(owned: Owned) -> Twhere
Owned: IntoSocketlike,

Constructs a new instance of Self from the given socketlike object converted from into_owned. Read more

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

const: unstable · 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.

impl<T> IntoFd for Twhere
OwnedFd: From<T>,

fn into_fd(self) -> OwnedFd

👎Deprecated since 1.0.0: IntoFd is replaced by From<...> for OwnedFd or Into<OwnedFd>

Consumes this object, returning the underlying file descriptor. Read more

impl<T> IntoFilelike for Twhere
T: Into<OwnedFd>,

fn into_filelike(self) -> OwnedFd

Consumes this object, returning the underlying filelike object. Read more

impl<T> IntoRawFilelike for Twhere
T: IntoRawFd,

fn into_raw_filelike(self) -> i32

Returns the raw value.

impl<T> IntoRawSocketlike for Twhere
T: IntoRawFd,

fn into_raw_socketlike(self) -> i32

Returns the raw value.

impl<T> IntoSocketlike for Twhere
T: Into<OwnedFd>,

fn into_socketlike(self) -> OwnedFd

Consumes this object, returning the underlying socketlike object.

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

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

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.