Struct tracing_core::stdlib::os::fd::OwnedFd

#[repr(transparent)]
pub struct OwnedFd {
    fd: i32,
}

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: i32

Implementations

impl OwnedFd

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

Available on Unix only.

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 AsRawFd for OwnedFd

fn as_raw_fd(&self) -> i32

Extracts the raw file descriptor.

impl Debug for OwnedFd

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

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

fn from(child_stderr: ChildStderr) -> OwnedFd

Takes ownership of a ChildStderr’s file descriptor.

impl From<ChildStdin> for OwnedFd

fn from(child_stdin: ChildStdin) -> OwnedFd

Takes ownership of a ChildStdin’s file descriptor.

impl From<ChildStdout> for OwnedFd

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

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

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

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) -> File

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

impl From<OwnedFd> for PidFd

fn from(fd: OwnedFd) -> PidFd

Converts to this type from the input type.

impl From<OwnedFd> for PipeReader

fn from(owned_fd: OwnedFd) -> PipeReader

Converts to this type from the input type.

impl From<OwnedFd> for PipeWriter

fn from(owned_fd: OwnedFd) -> PipeWriter

Converts to this type from the input type.

impl From<OwnedFd> for Stdio

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) -> TcpListener

Converts to this type from the input type.

impl From<OwnedFd> for TcpStream

fn from(owned_fd: OwnedFd) -> TcpStream

Converts to this type from the input type.

impl From<OwnedFd> for UdpSocket

fn from(owned_fd: OwnedFd) -> UdpSocket

Converts to this type from the input type.

impl From<OwnedFd> for UnixDatagram

fn from(owned: OwnedFd) -> UnixDatagram

Converts to this type from the input type.

impl From<OwnedFd> for UnixListener

fn from(fd: OwnedFd) -> UnixListener

Converts to this type from the input type.

impl From<OwnedFd> for UnixStream

fn from(owned: OwnedFd) -> UnixStream

Converts to this type from the input type.

impl From<PidFd> for OwnedFd

fn from(pid_fd: PidFd) -> OwnedFd

Converts to this type from the input type.

impl From<PipeReader> for OwnedFd

fn from(pipe: PipeReader) -> OwnedFd

Converts to this type from the input type.

impl From<PipeWriter> for OwnedFd

fn from(pipe: PipeWriter) -> OwnedFd

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

fn from(unix_datagram: UnixDatagram) -> OwnedFd

Takes ownership of a UnixDatagram’s socket file descriptor.

impl From<UnixListener> for OwnedFd

fn from(listener: UnixListener) -> OwnedFd

Takes ownership of a UnixListener’s socket file descriptor.

impl From<UnixStream> for OwnedFd

fn from(unix_stream: UnixStream) -> OwnedFd

Takes ownership of a UnixStream’s socket file descriptor.

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.

impl IsTerminal for OwnedFd

fn is_terminal(&self) -> bool

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