Skip to content

Wayland-rs version 0.22.0
Compare
Choose a tag to compare
@elinorbgr elinorbgr released this 31 Jan 21:53
· 735 commits to master since this release
v0.22.0
This tag was signed with the committer’s verified signature.
elinorbgr Elinor B.
GPG key ID: 5866DDBC86BE4680
Learn about vigilant mode.
fa6bac1
This commit was signed with the committer’s verified signature.
elinorbgr Elinor B.
GPG key ID: 5866DDBC86BE4680
Learn about vigilant mode.

This release brings yet another large redesign of the wayland-rs, many thanks to @YaLTeR for their help redesigning the API.

The most notable changes are as follow.

Objects have been transformed

The main objects that are manipulated are no longer Proxy<WlFoo>, but WlFoo objects directly (with access to the underlying Proxy via the AsRef trait and From/Into conversions (and similarly server-side with the Resources).

Associated with this RequestTraits are no longer, being replaced by inherent method on the WlFoo objects directly, for improved ergonomy, as you don't need to import all those traits any longer. Server-side objects now also have these methods.

Diversification of implementations

It is now possible to implement an object using a closure (as previously) or a struct implementing the associated EventHandler trait, depending on which is more practical for you.

It is also no longer unsafe to use a non-threadsafe implementation for objects, and it is now the default, as most use-case don't need the thread-safety anyway. It is still possible to opt-in into the safety though, if you need it.

If your workflow is more geared towards processing events in an iterator-like fashion rather than via callbacks, you can now use sinks. These are mpsc queues that can be used to implement any object. All objects implemented with a given sink will feed their event in a MsgIterator, that implements the Iterator trait. The BlockingMsgIter variant will additionally block on the wayland socket waiting for other events to arrive, allowing you to reduce your main event loop to a simple for loop, if you don't need to handle other sources of events.

Future-proofing the protocols

The enums generated from the protocol definitions are now explicitly nonexhaustive, as adding variants to them (enums, events and requests) is considered semver-compatible in Wayland land. This means that updating the protocol files is no longer a potential breaking change as it used to be.

General robustification

The pure rust implementation of the protocol is now much more strict about its state-keeping. Several issues about race conditions at the protocol level have been identified, fixed, and are now tested against. This process even managed to find a bug in the reference implementation (although a bug that is quite unlikely to trigger in practice).

For more details, you can check the full changelog.

Assets 2
Loading