W3cubDocs

/Rust

Struct OwnedFd 

pub struct OwnedFd { /* private fields */ }
Available on Unix or HermitCore or target_os=trusty or WASI or target_os=motor only.

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.0Source
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.0Source
impl AsFd for OwnedFd
Source
fn as_fd(&self) -> BorrowedFd<'_>
Borrows the file descriptor. Read more
1.63.0Source
impl AsRawFd for OwnedFd
Source
fn as_raw_fd(&self) -> RawFd
Extracts the raw file descriptor. Read more
1.63.0Source
impl Debug for OwnedFd
Source
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
1.63.0Source
impl Drop for OwnedFd
Source
fn drop(&mut self)
Executes the destructor for this type. Read more
1.63.0Source
impl From<ChildStderr> for OwnedFdAvailable on Unix only.
Source
fn from(child_stderr: ChildStderr) -> OwnedFd

Takes ownership of a ChildStderr’s file descriptor.

1.63.0Source
impl From<ChildStdin> for OwnedFdAvailable on Unix only.
Source
fn from(child_stdin: ChildStdin) -> OwnedFd

Takes ownership of a ChildStdin’s file descriptor.

1.63.0Source
impl From<ChildStdout> for OwnedFdAvailable on Unix only.
Source
fn from(child_stdout: ChildStdout) -> OwnedFd

Takes ownership of a ChildStdout’s file descriptor.

1.63.0Source
impl From<File> for OwnedFdAvailable on non-target_os=trusty only.
Source
fn from(file: File) -> OwnedFd

Takes ownership of a File’s underlying file descriptor.

1.74.0Source
impl From<OwnedFd> for ChildStderrAvailable 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.0Source
impl From<OwnedFd> for ChildStdinAvailable 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.0Source
impl From<OwnedFd> for ChildStdoutAvailable 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.0Source
impl From<OwnedFd> for FileAvailable on non-target_os=trusty only.
Source
fn from(owned_fd: OwnedFd) -> Self

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

Source
impl From<OwnedFd> for PidFdAvailable on Linux only.
Source
fn from(fd: OwnedFd) -> Self
Converts to this type from the input type.
1.87.0Source
impl From<OwnedFd> for PipeReaderAvailable on non-target_os=trusty only.
Source
fn from(owned_fd: OwnedFd) -> Self
Converts to this type from the input type.
1.87.0Source
impl From<OwnedFd> for PipeWriterAvailable on non-target_os=trusty only.
Source
fn from(owned_fd: OwnedFd) -> Self
Converts to this type from the input type.
1.63.0Source
impl From<OwnedFd> for StdioAvailable 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.0Source
impl From<OwnedFd> for TcpListenerAvailable on non-target_os=trusty only.
Source
fn from(owned_fd: OwnedFd) -> Self
Converts to this type from the input type.
1.63.0Source
impl From<OwnedFd> for TcpStreamAvailable on non-target_os=trusty only.
Source
fn from(owned_fd: OwnedFd) -> Self
Converts to this type from the input type.
1.63.0Source
impl From<OwnedFd> for UdpSocketAvailable on non-target_os=trusty only.
Source
fn from(owned_fd: OwnedFd) -> Self
Converts to this type from the input type.
1.63.0Source
impl From<OwnedFd> for UnixDatagramAvailable on Unix only.
Source
fn from(owned: OwnedFd) -> Self
Converts to this type from the input type.
1.63.0Source
impl From<OwnedFd> for UnixListenerAvailable on Unix only.
Source
fn from(fd: OwnedFd) -> UnixListener
Converts to this type from the input type.
1.63.0Source
impl From<OwnedFd> for UnixStreamAvailable on Unix only.
Source
fn from(owned: OwnedFd) -> Self
Converts to this type from the input type.
Source
impl From<PidFd> for OwnedFdAvailable on Linux only.
Source
fn from(pid_fd: PidFd) -> Self
Converts to this type from the input type.
1.87.0Source
impl From<PipeReader> for OwnedFdAvailable on non-target_os=trusty only.
Source
fn from(pipe: PipeReader) -> Self
Converts to this type from the input type.
1.87.0Source
impl From<PipeWriter> for OwnedFdAvailable on non-target_os=trusty only.
Source
fn from(pipe: PipeWriter) -> Self
Converts to this type from the input type.
1.63.0Source
impl From<TcpListener> for OwnedFdAvailable on non-target_os=trusty only.
Source
fn from(tcp_listener: TcpListener) -> OwnedFd

Takes ownership of a TcpListener’s socket file descriptor.

1.63.0Source
impl From<TcpStream> for OwnedFdAvailable on non-target_os=trusty only.
Source
fn from(tcp_stream: TcpStream) -> OwnedFd

Takes ownership of a TcpStream’s socket file descriptor.

1.63.0Source
impl From<UdpSocket> for OwnedFdAvailable on non-target_os=trusty only.
Source
fn from(udp_socket: UdpSocket) -> OwnedFd

Takes ownership of a UdpSocket’s file descriptor.

1.63.0Source
impl From<UnixDatagram> for OwnedFdAvailable on Unix only.
Source
fn from(unix_datagram: UnixDatagram) -> OwnedFd

Takes ownership of a UnixDatagram’s socket file descriptor.

1.63.0Source
impl From<UnixListener> for OwnedFdAvailable on Unix only.
Source
fn from(listener: UnixListener) -> OwnedFd

Takes ownership of a UnixListener’s socket file descriptor.

1.63.0Source
impl From<UnixStream> for OwnedFdAvailable on Unix only.
Source
fn from(unix_stream: UnixStream) -> OwnedFd

Takes ownership of a UnixStream’s socket file descriptor.

1.63.0Source
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.0Source
impl IntoRawFd for OwnedFd
Source
fn into_raw_fd(self) -> RawFd
Consumes this object, returning the raw underlying file descriptor. Read more
1.70.0Source
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

impl Freeze for OwnedFd
impl RefUnwindSafe for OwnedFd
impl Send for OwnedFd
impl Sync for OwnedFd
impl Unpin for OwnedFd
impl UnwindSafe for OwnedFd

Blanket Implementations

Source
impl<T> Any for Twhere
    T: 'static + ?Sized,
Source
fn type_id(&self) -> TypeId
Gets the TypeId of self. Read more
Source
impl<T> Borrow<T> for Twhere
    T: ?Sized,
Source
fn borrow(&self) -> &T
Immutably borrows from an owned value. Read more
Source
impl<T> BorrowMut<T> for Twhere
    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 Twhere
    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 Twhere
    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 Twhere
    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.

© 2010 The Rust Project Developers
Licensed under the Apache License, Version 2.0 or the MIT license, at your option.
https://doc.rust-lang.org/std/os/fd/struct.OwnedFd.html