Treeland Protocols Rust Bindings

English | 简体中文

Rust bindings for Treeland Wayland protocol extensions.

Overview

This crate provides Rust bindings to the Treeland Wayland protocol extensions. Treeland is a Wayland compositor developed by UnionTech/Deepin for DDE (Deepin Desktop Environment).

These bindings are built on top of wayland-client and wayland-server.

Project Structure

treeland-protocols-rs/
├── src/                      # Rust binding source code
│   ├── lib.rs               # Main library entry
│   └── protocol_macro.rs    # Protocol generation macro
├── treeland-protocols/      # Git submodule - protocol definitions
│   └── xml/                 # XML protocol files
├── Cargo.toml
└── README.md

Supported Protocols

All listed protocols are currently enabled and verified; if upstream protocol definitions change, they will be updated here.

Installation

Add this to your Cargo.toml:

[dependencies]
wayland-protocols-treeland = { git = "https://github.com/dwapp/treeland-protocols-rs" }

Features

• client (default): Enable client-side bindings
• server: Enable server-side bindings

# Client only (default)
wayland-protocols-treeland = { git = "..." }

# Server only
wayland-protocols-treeland = { git = "...", default-features = false, features = ["server"] }

# Both client and server
wayland-protocols-treeland = { git = "...", features = ["client", "server"] }

Usage Example

Registering a Global Shortcut

use wayland_client::{Connection, Dispatch, QueueHandle};
use wayland_protocols_treeland::shortcut_manager::v1::client::{
    treeland_shortcut_context_v1,
    treeland_shortcut_manager_v1,
};

struct AppData;

impl Dispatch<treeland_shortcut_manager_v1::TreelandShortcutManagerV1, ()> for AppData {
    fn event(
        _state: &mut Self,
        _proxy: &treeland_shortcut_manager_v1::TreelandShortcutManagerV1,
        _event: treeland_shortcut_manager_v1::Event,
        _data: &(),
        _conn: &Connection,
        _qh: &QueueHandle<Self>,
    ) {
        // Handle manager events
    }
}

impl Dispatch<treeland_shortcut_context_v1::TreelandShortcutContextV1, ()> for AppData {
    fn event(
        _state: &mut Self,
        _proxy: &treeland_shortcut_context_v1::TreelandShortcutContextV1,
        event: treeland_shortcut_context_v1::Event,
        _data: &(),
        _conn: &Connection,
        _qh: &QueueHandle<Self>,
    ) {
        match event {
            treeland_shortcut_context_v1::Event::Shortcut => {
                println!("Shortcut triggered!");
            }
            _ => {}
        }
    }
}

Getting Wallpaper Color

use wayland_protocols_treeland::wallpaper_color::v1::client::treeland_wallpaper_color_manager_v1;

// After binding the global...
// let color_manager = globals.bind::<treeland_wallpaper_color_manager_v1::TreelandWallpaperColorManagerV1, _, _>(...);

Building

# Clone with submodules
git clone --recursive https://github.com/dwapp/treeland-protocols-rs

cd treeland-protocols-rs

# Build
cargo build

# Run tests
cargo test

# Check all features
cargo check --all-features

Contributing

Contributions are welcome! Please note:

1. The treeland-protocols/ directory is a git submodule pointing to the upstream protocol definitions
2. Protocol bugs should be reported to the treeland-protocols repository
3. Binding issues can be reported here

Related Projects

• treeland - The Treeland Wayland compositor
• treeland-protocols - Protocol definitions
• wayland-rs - Rust Wayland bindings

License

This project is licensed under the MIT License - see the LICENSE file for details.

The protocol definitions in treeland-protocols/ are licensed separately, see that repository for details.