Struct wayland_client::Connection

pub struct Connection { /* fields omitted */ }

The Wayland connection

This is the main type representing your connection to the Wayland server. Most operations require access to either this type or the ConnectionHandle, which can be accessed through the handle() method, and is given to you in most callbacks.

Implementations

impl Connection

pub fn handle(&self) -> ConnectionHandle<'_>

Access the connection handle

pub fn connect_to_env() -> Result<Connection, ConnectError>

Try to connect to the Wayland server following the environment

This is the standard way to initialize a Wayland connection.

pub fn from_socket(stream: UnixStream) -> Result<Connection, ConnectError>

Initialize a Wayland connection from an already existing Unix stream

pub fn from_backend(backend: Arc<Mutex<Backend>>) -> Connection

Wrap an existing Backend into a Connection

pub fn backend(&self) -> Arc<Mutex<Backend>>

Get the Backend underlying this Connection

pub fn flush(&self) -> Result<(), WaylandError>

Flush pending outgoing events to the server

This needs to be done regularly to ensure the server receives all your requests.

pub fn prepare_read(&self) -> Result<ReadEventsGuard, WaylandError>

Start a synchronized read from the socket

This is needed if you plan to wait on readiness of the Wayland socket using an event loop. See ReadEventsGuard for details. Once the events are received, you’ll then need to dispatch them from the event queue using EventQueue::dispatch_pending().

If you don’t need to manage multiple event sources, see blocking_dispatch() for a simpler mechanism.

pub fn blocking_dispatch(&self) -> Result<usize, WaylandError>

Block until events are received from the server

This will flush the outgoing socket, and then block until events are received from the server and read them. You’ll then need to invoke EventQueue::dispatch_pending() to dispatch them on their respective event queues. Alternatively, EventQueue::blocking_dispatch() does both.

pub fn roundtrip(&self) -> Result<usize, WaylandError>

Do a roundtrip to the server

This method will block until the Wayland server has processed and answered all your preceding requests. This is notably useful during the initial setup of an app, to wait for the initial state from the server.

pub fn new_event_queue<D>(&self) -> EventQueue<D>

Create a new event queue

pub fn protocol_error(&self) -> Option<ProtocolError>

Retrive the protocol error that occured on the socket (if any)

Trait Implementations

impl Clone for Connection

fn clone(&self) -> Connection

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Connection

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

Formats the value using the given formatter.