x11rb::utils

Type Alias RawFdContainer

Source
pub type RawFdContainer = OwnedFd;
Expand description

A type representative of the file descriptors as they are sent to and from the X server.

On cfg(unix) platforms, this is a type alias for std::os::unix::io::OwnedFd. See the documentation for that type for more information on how it should be used. In most cases it can be cast into a File or UnixStream, or otherwise downgraded into the actual underlying file descriptor.

On non-Unix platforms, this is an uninhabited type in the same vogue as Void. As handle passing is an undefined operation on non-Unix implementations of the X11 protocol, instances of this type cannot exist. No operations can be called on this type. If handle passing is ever added to any reference implementation of the X11 protocol, this type will be changed to something that can be used to represent the file descriptors.

Consumers of this type should be careful to check for cfg(unix) before using it in any meaningful way. Otherwise, the program will not compile on non-Unix platforms.

Aliased Type§

struct RawFdContainer { /* private fields */ }

Implementations

Source§

impl OwnedFd

1.63.0 · Source

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

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

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

impl Debug for OwnedFd

Source§

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

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

Source§

fn from(child_stderr: ChildStderr) -> OwnedFd

Takes ownership of a ChildStderr’s file descriptor.

1.63.0 · Source§

impl From<ChildStdin> for OwnedFd

Source§

fn from(child_stdin: ChildStdin) -> OwnedFd

Takes ownership of a ChildStdin’s file descriptor.

1.63.0 · Source§

impl From<ChildStdout> for OwnedFd

Source§

fn from(child_stdout: ChildStdout) -> OwnedFd

Takes ownership of a ChildStdout’s file descriptor.

Source§

impl From<DefaultStream> for OwnedFd

Source§

fn from(stream: DefaultStream) -> Self

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

impl From<File> for OwnedFd

Source§

fn from(file: File) -> OwnedFd

Takes ownership of a File’s underlying file descriptor.

Source§

impl From<PidFd> for OwnedFd

Source§

fn from(pid_fd: PidFd) -> OwnedFd

Converts to this type from the input type.
Source§

impl From<PipeReader> for OwnedFd

Source§

fn from(pipe: PipeReader) -> OwnedFd

Converts to this type from the input type.
Source§

impl From<PipeWriter> for OwnedFd

Source§

fn from(pipe: PipeWriter) -> OwnedFd

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

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

Source§

fn from(listener: UnixListener) -> OwnedFd

Takes ownership of a UnixListener’s socket file descriptor.

1.63.0 · Source§

impl From<UnixStream> for OwnedFd

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

1.63.0 · Source§

impl IntoRawFd for OwnedFd

Source§

fn into_raw_fd(self) -> i32

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