Struct breadx::NameConnection

pub struct NameConnection { /* private fields */ }

A connection that can be derived from a parsed display name.

This is the primary Connection type that is used in breadx, as it represents the most common byte streams that are used to connect to the X11 server on modern OS. The display name, usually stored in the DISPLAY environment variable, is parsed and the connection is created from the parsed information.

This is a wrapper around either StdConnection<TcpStream> or, if on Unix, SendmsgConnection.

Implementations

impl NameConnection

pub fn new(name: Option<&str>) -> Result<Self>

Creates a new connection from a display name.

Blocking

This function blocks while it tries to connect to the server. Use the [new_async] function if you would like a non-blocking variant.

pub fn from_parsed_display(
    parsed_display: &ParsedDisplay,
    is_env: bool
) -> Result<Self>

Creates a new connection from an already parsed display name.

Blocking

This function blocks while it tries to connect to the server. Use the [from_parsed_display_async] function if you would like a non-blocking variant.

pub fn get_address(&self) -> Result<(Family, Vec<u8>)>

Get the peer address and family used in this connection.

This is useful, since the xauth interface requires the family and address to be known.

pub fn take_error(&self) -> Option<Error>

If there is an error associated with this socket, take it.

impl NameConnection

pub fn from_parsed_display_async<'a, Fut, R: 'a>(
    parsed_display: &'a ParsedDisplay,
    is_env: bool,
    resolv: impl FnMut(NameConnection) -> Fut + 'a
) -> impl Future<Output = Result<R>> + 'a where
    Fut: Future<Output = Result<R>> + 'a, 

Create a NameConnection in a non-blocking manner.

This function does not block, and will select the first connection that is available. The resolv parameter should poll the connection until it is writable using the currently availably runtime.

Trait Implementations

impl AsRawFd for NameConnection

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl Connection for NameConnection

fn send_slices_and_fds(
    &mut self,
    slices: &[IoSlice<'_>],
    fds: &mut Vec<Fd>
) -> Result<usize>

Write a series of I/O slices and a series of file descriptors to the X11 server.

fn recv_slices_and_fds(
    &mut self,
    slices: &mut [IoSliceMut<'_>],
    fds: &mut Vec<Fd>
) -> Result<usize>

Read data to a series of I/O slices and a buffer for file descriptors.

fn send_slices(&mut self, slices: &[IoSlice<'_>]) -> Result<usize>

Write a series of I/O slices to the X11 server.

fn send_slice(&mut self, slice: &[u8]) -> Result<usize>

Write a slice of data to the X11 server.

fn recv_slice_and_fds(
    &mut self,
    slice: &mut [u8],
    fds: &mut Vec<Fd>
) -> Result<usize>

Read data to a single I/O slice and a buffer for file descriptors.

fn recv_slice(&mut self, slice: &mut [u8]) -> Result<usize>

Read data for a single I/O slice.

fn flush(&mut self) -> Result<()>

Flush all data in this connection’s buffer.

fn shutdown(&self) -> Result<()>

Shutdown this connection.

fn non_blocking_recv_slice_and_fds(
    &mut self,
    slice: &mut [u8],
    fds: &mut Vec<Fd>
) -> Result<usize>

Receive data from the X11 server into a single slice, in a non-blocking manner.

fn non_blocking_recv_slices_and_fds(
    &mut self,
    slices: &mut [IoSliceMut<'_>],
    fds: &mut Vec<Fd>
) -> Result<usize>

Receive data from the X11 server into a set of I/O slices, in a non-blocking manner.

impl Connection for &NameConnection

fn send_slices_and_fds(
    &mut self,
    slices: &[IoSlice<'_>],
    fds: &mut Vec<Fd>
) -> Result<usize>

Write a series of I/O slices and a series of file descriptors to the X11 server.

fn recv_slices_and_fds(
    &mut self,
    slices: &mut [IoSliceMut<'_>],
    fds: &mut Vec<Fd>
) -> Result<usize>

Read data to a series of I/O slices and a buffer for file descriptors.

fn send_slices(&mut self, slices: &[IoSlice<'_>]) -> Result<usize>

Write a series of I/O slices to the X11 server.

fn send_slice(&mut self, slice: &[u8]) -> Result<usize>

Write a slice of data to the X11 server.

fn recv_slice_and_fds(
    &mut self,
    slice: &mut [u8],
    fds: &mut Vec<Fd>
) -> Result<usize>

Read data to a single I/O slice and a buffer for file descriptors.

fn recv_slice(&mut self, slice: &mut [u8]) -> Result<usize>

Read data for a single I/O slice.

fn flush(&mut self) -> Result<()>

Flush all data in this connection’s buffer.

fn shutdown(&self) -> Result<()>

Shutdown this connection.

fn non_blocking_recv_slice_and_fds(
    &mut self,
    slice: &mut [u8],
    fds: &mut Vec<Fd>
) -> Result<usize>

Receive data from the X11 server into a single slice, in a non-blocking manner.

fn non_blocking_recv_slices_and_fds(
    &mut self,
    slices: &mut [IoSliceMut<'_>],
    fds: &mut Vec<Fd>
) -> Result<usize>

Receive data from the X11 server into a set of I/O slices, in a non-blocking manner.

impl Debug for NameConnection

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

Formats the value using the given formatter.