Crate runa_core

Fundamental types and traits for a wayland compositor

This crate provides the scaffolding for writing a wayland compositor. It defines the traits for per-client and server global contexts, and traits for implementing wayland objects. It also provides helper for implementing these traits.

Structure of a compositor

Let’s break down a wayland compositor by looking at its data flow. (I used the word “data flow” loosely here.)

A wayland compositor starts by creating a socket and listening on it. Once a client connects to the socket, the compositor accepts the connection, and creates a new per-client context for it. The per-client context contains the object store, which will have a wl_display object already bound in it. The client can issue requests to objects in its object store, by referring to them with their object ID. The compositor handles these requests by calling the wayland interface implementations associated with the objects.

How this crate fits in

Function wayland_listener and wayland_listener_auto can be used to create the socket for incoming connections.

The traits in objects defines the interface of wayland objects. You can choose to implement wayland objects with them and the RequestDispatch traits generated from the wayland protocol spec (See the runa-wayland-protocols crate). Or you can also use the runa-orbiter crate which provides implementations for many of the wayland objects.

The Client trait defines the interface of a per-client context. See its documentation for more details. That trait explains how most of the other stuffs fit together.

The Server trait is responsible for creating a new client context each time a new client connects. It also provides access to the globals.

Modules

• client
  Per-client state
• error
  Error traits and types
• events
  Traits and types related to event
• globals
  Traits and type related to wayland globals
• objects
  Interfaces for wayland objects
• provide_any
  The provide_any API “borrowed” from the Rust libstd.
• server
  Traits and types related to the server global context.

Macros

• globals
  Generate a corresponding Objects enum from a Globals enum.

Structs

• ConnectionManager
  A connection manager that accepts incoming connections from a listener, and then calls Server::new_connection for each connection.
• FlockGuard
  A guard that unlocks the lock file when dropped.

Enums

• ConnectionManagerError
  Errors that can be reported by a connection manager.
• ListenerError
  Errors that can occur when creating a wayland listener.

Traits

• Serial
  Event serial management. (WIP, not currently used)

Functions

• wayland_listener
  Create a UnixListener for accepting incoming connections from wayland clients.
• wayland_listener_auto
  Create a UnixListener for accepting incoming connections from wayland clients.