Crate x11rb_async

source ·
Expand description

Asynchronous X11 rust bindings.

This library allows to interact with an X11 server from rust code. A connection to an X11 server is represented by an implementation of the Connection trait.

The client can interact with the server by sending requests. The server can answer requests and can also generate events.

The examples that come with this library might be a good starting point for new users.

§Feature flags

This crate uses feature flags to reduce the amount of compiled code. There are two kinds of feature flags available:

  • Feature flags for specific X11 extensions
  • Feature flags for additional functionality

§Feature flags for specific X11 extensions

By default, only the core X11 protocol and X11 extensions that are needed internally are enabled. These are the bigreq, ge and xc_misc extensions. Further extensions need to be explicitly enabled via their feature flag:

composite, damage, dpms, dri2, dri3, glx, present, randr, record, render, res, screensaver, shape, shm, sync, xevie, xf86dri, xf86vidmode, xfixes, xinerama, xinput, xkb, xprint, xselinux, xtest, xv, xvmc.

If you want to take the “I do not want to think about this”-approach, you can enable the all-extensions feature to just enable, well, all extensions.

§Feature flags for additional functionality

Additionally, the following flags exist:

  • allow-unsafe-code: Enable the same feature in x11rb and implement blocking::BlockingConnection for x11rb::xcb_ffi::XCBConnection
  • extra-traits: Implement extra traits for X11 types. This improves the output of the Debug impl and adds PartialEq, Eq, PartialOrd, Ord, and Hash where possible.

Modules§

  • blocking
    A Connection implementation that uses a threadpool to handle requests.
  • connection
    Generic connection-related traits.
  • errors
    This module contains the current mess that is error handling.
  • protocol
    Bindings to the X11 protocol.
  • rust_connection
    An implementation of a pure-Rust async connection to an X11 server.
  • utils
    Utility functions that are not specific to X11.
  • x11_utils
    Some utilities for working with X11.

Structs§

  • Cookie
    A cookie for a request that has a reply.
  • CookieWithFds
    A cookie for a request that has a reply containing file descriptors.
  • VoidCookie
    A cookie for a request without a reply.

Type Aliases§

  • SequenceNumber
    Number type used for referring to things that were sent to the server in responses from the server.