4 releases (stable)

1.0.2 May 7, 2024
1.0.1 May 3, 2024
1.0.0 Apr 16, 2024
0.1.0 Mar 11, 2024

#54 in #wayland

Download history 133/week @ 2024-03-09 15/week @ 2024-03-16 2/week @ 2024-03-23 19/week @ 2024-03-30 2/week @ 2024-04-06 147/week @ 2024-04-13 70/week @ 2024-04-20 233/week @ 2024-04-27 520/week @ 2024-05-04 214/week @ 2024-05-11 165/week @ 2024-05-18 168/week @ 2024-05-25 170/week @ 2024-06-01 131/week @ 2024-06-08

669 downloads per month
Used in 11 crates (via wayrs-client)

MIT license

668 lines


A simple Rust implementation of Wayland client library.

Design decisions

  • Single event queue
  • No interior mutability
  • No libwayland compatibility
  • Support blocking, non-blocking and async IO

Project status

  • The main crate, wayrs-client, is feature complete and stable.

Project structure

The project is split into multiple crates:

  • wayrs-client: The main crate which implements Wayland wire protocol. Provides Connection type which represents open Wayland socket, manages objects and handles callbacks.
  • wayrs-protocols: A collection of Wayland protocols to use with wayrs-client.
  • wayrs-utils: A collection of utils and abstractions for wayrs-client. Includes a shared memory allocator and more.
  • wayrs-egl: Brings OpenGL(-ES) to wayrs. Based on EGL_KHR_platform_gbm.
  • wayrs-scanner: Implements the wayrs_client:::generate! macro that generates glue code from .xml files. Generated code for the core protocol is already included in wayrs-client::protocol. Do not use this crate directly.
  • wayrs-proto-parser: Parses wayland .xml files. Used by wayrs-scanner.
  • wayrs-core: The core types, marshalling and unmarshalling implementation. Can be used by clients and servers.

Projects using wayrs

The following projects use wayrs and may serve as additional usage examples:

  • i3bar-river: Port of i3bar for river.
  • i3status-rs: Feature-rich and resource-friendly replacement for i3status.
  • river-kbd-layout-watcher: Prints current keyboard layout whenever it changes.
  • wayidle: Waits until the compositor reports being N seconds idle.
  • wl-gammarelay-rs: Provides DBus interface to control display temperature and brightness without flickering.
  • wlr-which-key: Keymap manager for wlroots-based compositors.




~17K SLoC