std::os::fd

Struct OwnedFd

1.63.0 · source
pub struct OwnedFd { /* private fields */ }
Expand description

An owned file descriptor.

This closes the file descriptor on drop. It is guaranteed that nobody else 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 a consumed argument or returned as an owned value, and it never has the value -1.

You can use AsFd::as_fd to obtain a BorrowedFd.

Implementations§

source§

impl OwnedFd

1.63.0 · source

pub fn try_clone(&self) -> Result<Self>

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

Trait Implementations§

1.63.0 · source§

impl AsFd for OwnedFd

source§

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

Borrows the file descriptor. Read more
1.63.0 · source§

impl AsRawFd for OwnedFd

source§

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor. Read more
1.63.0 · source§

impl Debug for OwnedFd

source§

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

Formats the value using the given formatter. Read more
1.63.0 · source§

impl Drop for OwnedFd

source§

fn drop(&mut self)

Executes the destructor for this type. Read more
1.63.0 · source§

impl From<ChildStderr> for OwnedFd

Available on Unix only.
source§

fn from(child_stderr: ChildStderr) -> OwnedFd

Takes ownership of a ChildStderr’s file descriptor.

1.63.0 · source§

impl From<ChildStdin> for OwnedFd

Available on Unix only.
source§

fn from(child_stdin: ChildStdin) -> OwnedFd

Takes ownership of a ChildStdin’s file descriptor.

1.63.0 · source§

impl From<ChildStdout> for OwnedFd

Available on Unix only.
source§

fn from(child_stdout: ChildStdout) -> OwnedFd

Takes ownership of a ChildStdout’s file descriptor.

1.63.0 · source§

impl From<File> for OwnedFd

source§

fn from(file: File) -> OwnedFd

Takes ownership of a File’s underlying file descriptor.

1.74.0 · source§

impl From<OwnedFd> for ChildStderr

Available on Unix only.

Creates a ChildStderr from the provided OwnedFd.

The provided file descriptor must point to a pipe with the CLOEXEC flag set.

source§

fn from(fd: OwnedFd) -> ChildStderr

Converts to this type from the input type.
1.74.0 · source§

impl From<OwnedFd> for ChildStdin

Available on Unix only.

Creates a ChildStdin from the provided OwnedFd.

The provided file descriptor must point to a pipe with the CLOEXEC flag set.

source§

fn from(fd: OwnedFd) -> ChildStdin

Converts to this type from the input type.
1.74.0 · source§

impl From<OwnedFd> for ChildStdout

Available on Unix only.

Creates a ChildStdout from the provided OwnedFd.

The provided file descriptor must point to a pipe with the CLOEXEC flag set.

source§

fn from(fd: OwnedFd) -> ChildStdout

Converts to this type from the input type.
1.63.0 · source§

impl From<OwnedFd> for File

source§

fn from(owned_fd: OwnedFd) -> Self

Returns a File that takes ownership of the given file descriptor.

source§

impl From<OwnedFd> for PidFd

Available on Linux only.
source§

fn from(fd: OwnedFd) -> Self

Converts to this type from the input type.
source§

impl From<OwnedFd> for PipeReader

source§

fn from(owned_fd: OwnedFd) -> Self

Converts to this type from the input type.
source§

impl From<OwnedFd> for PipeWriter

source§

fn from(owned_fd: OwnedFd) -> Self

Converts to this type from the input type.
1.63.0 · source§

impl From<OwnedFd> for Stdio

Available on Unix only.
source§

fn from(fd: OwnedFd) -> Stdio

Takes ownership of a file descriptor and returns a Stdio that can attach a stream to it.

1.63.0 · source§

impl From<OwnedFd> for TcpListener

source§

fn from(owned_fd: OwnedFd) -> Self

Converts to this type from the input type.
1.63.0 · source§

impl From<OwnedFd> for TcpStream

source§

fn from(owned_fd: OwnedFd) -> Self

Converts to this type from the input type.
1.63.0 · source§

impl From<OwnedFd> for UdpSocket

source§

fn from(owned_fd: OwnedFd) -> Self

Converts to this type from the input type.
1.63.0 · source§

impl From<OwnedFd> for UnixDatagram

Available on Unix only.
source§

fn from(owned: OwnedFd) -> Self

Converts to this type from the input type.
1.63.0 · source§

impl From<OwnedFd> for UnixListener

Available on Unix only.
source§

fn from(fd: OwnedFd) -> UnixListener

Converts to this type from the input type.
1.63.0 · source§

impl From<OwnedFd> for UnixStream

Available on Unix only.
source§

fn from(owned: OwnedFd) -> Self

Converts to this type from the input type.
source§

impl From<PidFd> for OwnedFd

Available on Linux only.
source§

fn from(pid_fd: PidFd) -> Self

Converts to this type from the input type.
source§

impl From<PipeReader> for OwnedFd

source§

fn from(pipe: PipeReader) -> Self

Converts to this type from the input type.
source§

impl From<PipeWriter> for OwnedFd

source§

fn from(pipe: PipeWriter) -> Self

Converts to this type from the input type.
1.63.0 · source§

impl From<TcpListener> for OwnedFd

source§

fn from(tcp_listener: TcpListener) -> OwnedFd

Takes ownership of a TcpListener’s socket file descriptor.

1.63.0 · source§

impl From<TcpStream> for OwnedFd

source§

fn from(tcp_stream: TcpStream) -> OwnedFd

Takes ownership of a TcpStream’s socket file descriptor.

1.63.0 · source§

impl From<UdpSocket> for OwnedFd

source§

fn from(udp_socket: UdpSocket) -> OwnedFd

Takes ownership of a UdpSocket’s file descriptor.

1.63.0 · source§

impl From<UnixDatagram> for OwnedFd

Available on Unix only.
source§

fn from(unix_datagram: UnixDatagram) -> OwnedFd

Takes ownership of a UnixDatagram’s socket file descriptor.

1.63.0 · source§

impl From<UnixListener> for OwnedFd

Available on Unix only.
source§

fn from(listener: UnixListener) -> OwnedFd

Takes ownership of a UnixListener’s socket file descriptor.

1.63.0 · source§

impl From<UnixStream> for OwnedFd

Available on Unix only.
source§

fn from(unix_stream: UnixStream) -> OwnedFd

Takes ownership of a UnixStream’s socket file descriptor.

1.63.0 · source§

impl FromRawFd for OwnedFd

source§

unsafe fn from_raw_fd(fd: RawFd) -> Self

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.

1.63.0 · source§

impl IntoRawFd for OwnedFd

source§

fn into_raw_fd(self) -> RawFd

Consumes this object, returning the raw underlying file descriptor. Read more
1.70.0 · source§

impl IsTerminal for OwnedFd

source§

fn is_terminal(&self) -> bool

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

Auto Trait Implementations§

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

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

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.

source§

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

source§

type Error = Infallible

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

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

source§

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

The type returned in the event of a conversion error.
source§

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

Performs the conversion.