Struct RustConnection

pub struct RustConnection<S = DefaultStream> { /* private fields */ }

A pure-Rust async connection to an X11 server.

Implementations

impl RustConnection

pub async fn connect( display_name: Option<&str>, ) -> Result<(Self, usize, impl Future<Output = Result<Infallible, ConnectionError>> + Send), ConnectError>

Connect to the X11 server.

This function returns a future that drives the packet reader for the connection. It should be spawned on a task executor to be polled while the connection is in use.

impl<S: Stream + Send + Sync> RustConnection<S>

pub async fn connect_to_stream( stream: S, screen: usize, ) -> Result<(Self, impl Future<Output = Result<Infallible, ConnectionError>> + Send), ConnectError>

Connect to the X11 server using the given stream.

This function returns a future that drives the packet reader for the connection. It should be spawned on a task executor to be polled while the connection is in use.

pub async fn connect_to_stream_with_auth_info( stream: S, screen: usize, auth_name: Vec<u8>, auth_data: Vec<u8>, ) -> Result<(Self, impl Future<Output = Result<Infallible, ConnectionError>> + Send), ConnectError>

Connect to the server using the given stream and authentication information.

This function returns a future that drives the packet reader for the connection. It should be spawned on a task executor to be polled while the connection is in use.

pub fn for_connected_stream( stream: S, setup: Setup, ) -> Result<(Self, impl Future<Output = Result<Infallible, ConnectionError>> + Send), ConnectError>

Establish a connection on an already connected stream.

This function returns a future that drives the packet reader for the connection. It should be spawned on a task executor to be polled while the connection is in use.

Trait Implementations

impl<S: Stream + Send + Sync> Connection for RustConnection<S>

fn wait_for_raw_event_with_sequence( &self, ) -> Pin<Box<dyn Future<Output = Result<RawEventAndSeqNumber<Self::Buf>, ConnectionError>> + Send + '_>>

Wait for a raw/unparsed event from the X11 server.

fn poll_for_raw_event_with_sequence( &self, ) -> Result<Option<RawEventAndSeqNumber<Self::Buf>>, ConnectionError>

Poll for a raw/unparsed event from the X11 server.

fn flush( &self, ) -> Pin<Box<dyn Future<Output = Result<(), ConnectionError>> + Send + '_>>

Flush the output buffer.

fn setup(&self) -> &Setup

Get the setup information of the connection.

fn generate_id( &self, ) -> Pin<Box<dyn Future<Output = Result<u32, ReplyOrIdError>> + Send + '_>>

Generate a new X11 identifier.

fn wait_for_event( &self, ) -> Pin<Box<dyn Future<Output = Result<Event, ConnectionError>> + Send + '_>>

Wait for a new event from the X11 server.

fn wait_for_raw_event( &self, ) -> Pin<Box<dyn Future<Output = Result<Self::Buf, ConnectionError>> + Send + '_>>

Wait for a new event from the X11 server.

fn wait_for_event_with_sequence( &self, ) -> Pin<Box<dyn Future<Output = Result<EventAndSeqNumber, ConnectionError>> + Send + '_>>

Wait for a new event from the X11 server.

fn poll_for_event(&self) -> Result<Option<Event>, ConnectionError>

Poll for a new event from the X11 server.

fn poll_for_raw_event(&self) -> Result<Option<Self::Buf>, ConnectionError>

Poll for a raw/unparsed event from the X11 server.

fn poll_for_event_with_sequence( &self, ) -> Result<Option<EventAndSeqNumber>, ConnectionError>

Poll for a new event from the X11 server.

impl<S: Debug> Debug for RustConnection<S>

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

Formats the value using the given formatter.

impl<S: Stream + Send + Sync> RequestConnection for RustConnection<S>

type Buf = Vec<u8>

Type used as buffer to store raw replies or events before they are parsed.

fn send_request_with_reply<'this, 'bufs, 'sl, 're, 'future, R>( &'this self, bufs: &'bufs [IoSlice<'sl>], fds: Vec<RawFdContainer>, ) -> Pin<Box<dyn Future<Output = Result<Cookie<'this, Self, R>, ConnectionError>> + Send + 'future>>

where R: TryParse + Send + 're, 'this: 'future, 'bufs: 'future, 'sl: 'future, 're: 'future,

Send a request with a reply to the server.

fn send_request_with_reply_with_fds<'this, 'bufs, 'sl, 're, 'future, R>( &'this self, bufs: &'bufs [IoSlice<'sl>], fds: Vec<RawFdContainer>, ) -> Pin<Box<dyn Future<Output = Result<CookieWithFds<'this, Self, R>, ConnectionError>> + Send + 'future>>

where R: TryParseFd + Send + 're, 'this: 'future, 'bufs: 'future, 'sl: 'future, 're: 'future,

Send a request with a reply containing file descriptors to the server.

fn send_request_without_reply<'this, 'bufs, 'sl, 'future>( &'this self, bufs: &'bufs [IoSlice<'sl>], fds: Vec<RawFdContainer>, ) -> Pin<Box<dyn Future<Output = Result<VoidCookie<'this, Self>, ConnectionError>> + Send + 'future>>

where 'this: 'future, 'bufs: 'future, 'sl: 'future,

Send a request without a reply to the server.

fn discard_reply( &self, sequence: SequenceNumber, _kind: RequestKind, mode: DiscardMode, )

The reply for this request shoiuld be discarded.

fn prefetch_extension_information( &self, name: &'static str, ) -> Pin<Box<dyn Future<Output = Result<(), ConnectionError>> + Send + '_>>

Prefetch information about an extension.

fn extension_information( &self, name: &'static str, ) -> Pin<Box<dyn Future<Output = Result<Option<ExtensionInformation>, ConnectionError>> + Send + '_>>

Get information about an extension.

fn wait_for_reply_or_raw_error( &self, sequence: SequenceNumber, ) -> Pin<Box<dyn Future<Output = Result<ReplyOrError<Self::Buf>, ConnectionError>> + Send + '_>>

Wait for the reply to a request.

fn wait_for_reply( &self, sequence: SequenceNumber, ) -> Pin<Box<dyn Future<Output = Result<Option<Self::Buf>, ConnectionError>> + Send + '_>>

Wait for the reply to a request.

fn wait_for_reply_with_fds_raw( &self, sequence: SequenceNumber, ) -> Pin<Box<dyn Future<Output = Result<ReplyOrError<BufWithFds<Self::Buf>, Self::Buf>, ConnectionError>> + Send + '_>>

Wait for the reply to a request with file descriptors.

fn check_for_raw_error( &self, sequence: SequenceNumber, ) -> Pin<Box<dyn Future<Output = Result<Option<Self::Buf>, ConnectionError>> + Send + '_>>

Check whether a request has errored.

fn prefetch_maximum_request_bytes( &self, ) -> Pin<Box<dyn Future<Output = ()> + Send + '_>>

Prefetches the maximum request length.

fn maximum_request_bytes( &self, ) -> Pin<Box<dyn Future<Output = usize> + Send + '_>>

Get the maximum request length.

fn parse_error(&self, error: &[u8]) -> Result<X11Error, ParseError>

Parse a generic error.

fn parse_event(&self, event: &[u8]) -> Result<Event, ParseError>

Parse a generic event.

fn send_trait_request_with_reply<'this, 'req, 'future, R>( &'this self, request: R, ) -> Pin<Box<dyn Future<Output = Result<Cookie<'_, Self, R::Reply>, ConnectionError>> + Send + 'future>>

where R: ReplyRequest + Send + 'req, R::Reply: Send, 'this: 'future, 'req: 'future,

Send a request with a reply to the server.

fn send_trait_request_with_reply_with_fds<'this, 'req, 'future, R>( &'this self, request: R, ) -> Pin<Box<dyn Future<Output = Result<CookieWithFds<'_, Self, R::Reply>, ConnectionError>> + Send + 'future>>

where R: ReplyFDsRequest + Send + 'req, R::Reply: Send, 'this: 'future, 'req: 'future,

Send a request with a reply containing file descriptors to the server.

fn send_trait_request_without_reply<'this, 'req, 'future, R>( &'this self, request: R, ) -> Pin<Box<dyn Future<Output = Result<VoidCookie<'this, Self>, ConnectionError>> + Send + 'future>>

where R: VoidRequest + Send + 'req, 'this: 'future, 'req: 'future,

Send a request without a reply to the server.

fn wait_for_reply_or_error( &self, sequence: SequenceNumber, ) -> Pin<Box<dyn Future<Output = Result<Self::Buf, ReplyError>> + Send + '_>>

Wait for the reply to a request.

fn wait_for_reply_with_fds( &self, sequence: SequenceNumber, ) -> Pin<Box<dyn Future<Output = Result<BufWithFds<Self::Buf>, ReplyError>> + Send + '_>>

Wait for the reply to a request with file descriptors.

fn check_for_error( &self, sequence: SequenceNumber, ) -> Pin<Box<dyn Future<Output = Result<(), ReplyError>> + Send + '_>>

Check whether a request has errored.