Struct DefaultStream

pub struct DefaultStream { /* private fields */ }

A wrapper around a TcpStream or UnixStream.

Use by default in RustConnection as stream.

Implementations

impl DefaultStream

pub fn connect(addr: &ConnectAddress<'_>) -> Result<(Self, (Family, Vec<u8>))>

Try to connect to the X11 server described by the given arguments.

pub fn from_tcp_stream(stream: TcpStream) -> Result<(Self, (Family, Vec<u8>))>

Creates a new Stream from an already connected TcpStream.

The stream will be set in non-blocking mode.

This returns the peer address in a format suitable for [x11rb_protocol::xauth::get_auth].

pub fn from_unix_stream(stream: UnixStream) -> Result<(Self, (Family, Vec<u8>))>

Creates a new Stream from an already connected UnixStream.

The stream will be set in non-blocking mode.

This returns the peer address in a format suitable for [x11rb_protocol::xauth::get_auth].

Trait Implementations

impl AsFd for DefaultStream

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

Borrows the file descriptor.

impl AsRawFd for DefaultStream

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl Debug for DefaultStream

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

Formats the value using the given formatter.

impl From<DefaultStream> for OwnedFd

fn from(stream: DefaultStream) -> Self

Converts to this type from the input type.

impl IntoRawFd for DefaultStream

fn into_raw_fd(self) -> RawFd

Consumes this object, returning the raw underlying file descriptor.

impl Stream for DefaultStream

fn poll(&self, mode: PollMode) -> Result<()>

Waits for level-triggered read and/or write events on the stream.

fn read( &self, buf: &mut [u8], fd_storage: &mut Vec<RawFdContainer>, ) -> Result<usize>

Read some bytes and FDs from this reader without blocking, returning how many bytes were read.

fn write(&self, buf: &[u8], fds: &mut Vec<RawFdContainer>) -> Result<usize>

Write a buffer and some FDs into this writer without blocking, returning how many bytes were written.

fn write_vectored( &self, bufs: &[IoSlice<'_>], fds: &mut Vec<RawFdContainer>, ) -> Result<usize>

Like write, except that it writes from a slice of buffers. Like write, this method must never block.