Struct OwnedFd

#[repr(transparent)]
pub struct OwnedFd {
    fd: NotAllOnes<RawFd>,
}

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.

Fields

fd: NotAllOnes<RawFd>

Implementations

impl OwnedFd

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

impl AsFd for OwnedFd

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

Borrows the file descriptor.

impl AsInner<OwnedFd> for FileDesc

fn as_inner(&self) -> &OwnedFd

impl AsRawFd for OwnedFd

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl Debug for OwnedFd

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

Formats the value using the given formatter.

impl Drop for OwnedFd

fn drop(&mut self)

Executes the destructor for this type.

impl From<ChildStderr> for OwnedFd

Available on Unix only.

fn from(child_stderr: ChildStderr) -> OwnedFd

Takes ownership of a ChildStderr’s file descriptor.

impl From<ChildStdin> for OwnedFd

Available on Unix only.

fn from(child_stdin: ChildStdin) -> OwnedFd

Takes ownership of a ChildStdin’s file descriptor.

impl From<ChildStdout> for OwnedFd

Available on Unix only.

fn from(child_stdout: ChildStdout) -> OwnedFd

Takes ownership of a ChildStdout’s file descriptor.

impl From<File> for OwnedFd

fn from(file: File) -> OwnedFd

Takes ownership of a File’s underlying file descriptor.

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.

fn from(fd: OwnedFd) -> ChildStderr

Converts to this type from the input type.

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.

fn from(fd: OwnedFd) -> ChildStdin

Converts to this type from the input type.

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.

fn from(fd: OwnedFd) -> ChildStdout

Converts to this type from the input type.

impl From<OwnedFd> for File

fn from(owned_fd: OwnedFd) -> Self

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

impl From<OwnedFd> for PidFd

Available on Linux only.

fn from(fd: OwnedFd) -> Self

Converts to this type from the input type.

impl From<OwnedFd> for PipeReader

fn from(owned_fd: OwnedFd) -> Self

Converts to this type from the input type.

impl From<OwnedFd> for PipeWriter

fn from(owned_fd: OwnedFd) -> Self

Converts to this type from the input type.

impl From<OwnedFd> for Stdio

Available on Unix only.

fn from(fd: OwnedFd) -> Stdio

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

impl From<OwnedFd> for TcpListener

fn from(owned_fd: OwnedFd) -> Self

Converts to this type from the input type.

impl From<OwnedFd> for TcpStream

fn from(owned_fd: OwnedFd) -> Self

Converts to this type from the input type.

impl From<OwnedFd> for UdpSocket

fn from(owned_fd: OwnedFd) -> Self

Converts to this type from the input type.

impl From<OwnedFd> for UnixDatagram

Available on Unix only.

fn from(owned: OwnedFd) -> Self

Converts to this type from the input type.

impl From<OwnedFd> for UnixListener

Available on Unix only.

fn from(fd: OwnedFd) -> UnixListener

Converts to this type from the input type.

impl From<OwnedFd> for UnixStream

Available on Unix only.

fn from(owned: OwnedFd) -> Self

Converts to this type from the input type.

impl From<PidFd> for OwnedFd

Available on Linux only.

fn from(pid_fd: PidFd) -> Self

Converts to this type from the input type.

impl From<PipeReader> for OwnedFd

fn from(pipe: PipeReader) -> Self

Converts to this type from the input type.

impl From<PipeWriter> for OwnedFd

fn from(pipe: PipeWriter) -> Self

Converts to this type from the input type.

impl From<TcpListener> for OwnedFd

fn from(tcp_listener: TcpListener) -> OwnedFd

Takes ownership of a TcpListener’s socket file descriptor.

impl From<TcpStream> for OwnedFd

fn from(tcp_stream: TcpStream) -> OwnedFd

Takes ownership of a TcpStream’s socket file descriptor.

impl From<UdpSocket> for OwnedFd

fn from(udp_socket: UdpSocket) -> OwnedFd

Takes ownership of a UdpSocket’s file descriptor.

impl From<UnixDatagram> for OwnedFd

Available on Unix only.

fn from(unix_datagram: UnixDatagram) -> OwnedFd

Takes ownership of a UnixDatagram’s socket file descriptor.

impl From<UnixListener> for OwnedFd

Available on Unix only.

fn from(listener: UnixListener) -> OwnedFd

Takes ownership of a UnixListener’s socket file descriptor.

impl From<UnixStream> for OwnedFd

Available on Unix only.

fn from(unix_stream: UnixStream) -> OwnedFd

Takes ownership of a UnixStream’s socket file descriptor.

impl FromInner<OwnedFd> for FileDesc

fn from_inner(owned_fd: OwnedFd) -> Self

impl FromRawFd for OwnedFd

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.

impl IntoInner<OwnedFd> for FileDesc

fn into_inner(self) -> OwnedFd

impl IntoRawFd for OwnedFd

fn into_raw_fd(self) -> RawFd

Consumes this object, returning the raw underlying file descriptor.

impl IsTerminal for OwnedFd

fn is_terminal(&self) -> bool

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

impl Sealed for OwnedFd