Module breadx::display[][src]

Expand description

This module defines the Display object, which acts as a connection to the X11 server, and the Connection trait, which the Display object abstracts itself over. See the documentation for these objects for more information.

Modules

name

This module defines the NameConnection type, which is the default connection used for Display objects. See the NameConnection object for more information.

prelude
traits

Structs

BasicDisplay

An implementor of Display and AsyncDisplay that requires &mut access in order to use.

CellDisplay

An implementor of Display and AsyncDisplay that uses Cell and RefCell in order to allow for immutable use of the Display. The primary downside is that it is not Sync.

GcParameters
KeyboardMapping
MapFuture

A simple future that maps one value onto another using a closure.

PendingReply

A reply, pending returning from the display.

PendingRequest
PendingRequestFlags
ReadPacketFuture

The future returned by AsyncConnectionExt::read_packet.

RequestCookie

A cookie for a request.

RequestInfo

Request information, monomorphized from the Request trait.

SendPacketFuture

The future returned by AsyncConnectionExt::send_packet.

SendRequestFuture

The future returned by the AsyncDisplayExt::send_request_async method. It is a basic wrapper around sending the raw request.

SendRequestRawFuture

The future returned by send_request_raw_async. This polls the AsyncDisplay instance until it returns properly.

WaitFuture

The future created by the AsyncDisplayExt::wait_async method; runs the poll_wait function until it returns Ready.

WindowParameters

Enums

EitherFuture

Run one future or the other.

EstablishConnectionFuture

Future returned by establish_async.

ExchangeRequestFuture

The future returned by the AsyncDisplayExt::request_exchange_async function.

ExchangeXidFuture

An ExchangeRequestFuture, but it potentially returns an XID.

PendingItem

Combines PendingRequest, PendingReply, and BreadError into one type, to simplify some of the APIs.

PollOr

Utility type to represent a polling result that returns another object if it fails.

PutImageFuture

The future returned by the put_image_async function.

RequestWorkaround
ResolveRequestFuture

The future returned by AsyncDisplayExt::resolve_request_async.

SynchronizeFuture

The future returned by AsyncDisplayExt::synchronize_async, which sends a simple request and then waits for a reply to appear.

Traits

AsyncConnection

Asynchronous breadx connection.

AsyncConnectionExt

Extension trait for AsyncConnection that provides futures.

AsyncDisplay

A wrapper around an asynchronous connection to the X server.

AsyncDisplayExt

Monomorphized methods we can’t put into the AsyncDisplay trait proper.

Connection

Synchronous breadx connection.

Display

A wrapper around a synchronous connection to the X11 server.

DisplayBase

This trait represents a connection to the X11 server. Most operations in breadx revolve around an object implementing this trait in some way, shape, or form.

DisplayExt

Monomorphized methods we can’t put into the Display trait proper.

Functions

rgb

Convenience function for producing an RGB pixel value for supported monitors.

Type Definitions

AsyncDisplayConnection
DisplayConnection

A variant of BasicDisplay that uses X11’s default connection mechanisms to connect to the server. In most cases, you should be using either this, or converting this type to a CellDisplay or SyncDisplay.

GenericConnFuture

Generic future for connections;

ResolveRequestRawFuture

The future returned by AsyncDisplayExt::ResolveRequestRaw.

WaitForEventFuture

The future returned by AsyncDisplayExt::wait_for_event_async.

WaitForSpecialEventFuture

The future returned by AsyncDisplayExt::WaitForSpecialEvent.