3f3f6c2fc6
This patch changes the signature of `CrossProcessLock::try_lock_once`. It was returning a: ```rust Result<CrossProcessLockResult, CrossProcessLockError> ``` Now it returns a: ```rust Result<Result<CrossProcessLockKind, CrossProcessLockUnobtained>, L::LockError> ``` We will explain these new types in a moment. This patch also changes the signature of `CrossProcessLock::spin_lock`. It was returning a: ```rust Result<CrossProcessLockGuard, CrossProcessLockError> ``` Now it returns a: ```rust Result<Result<CrossProcessLockKind, CrossProcessLockUnobtained>, L::LockError> ``` First off, we notice that the returned types are now unified. The `CrossProcessLockResult` type has been renamed `CrossProcessLockKind` and lives in a `Result::Ok`. The `CrossProcessLockResult::Unobtained` variant has been removed, but `CrossProcessLockUnobtainedReason` has been renamed to `CrossProcessLockUnobtained` and lives in a `Result::Err`. Second, the `CrossProcessLockError` now is a union type between `CrossProcessLockUnobtained` and `TryLock::LockError`. It's not used by `try_lock_once` or `spin_lock`, but only by the code using the cross-process lock to provide a unified error type. The ideas behind these changes are: - it's easy to forward an error from the `TryLock`, - it's difficult to ignore the `Clean` vs. `Dirty` state of the lock guard, - unified API with clearly separated responsibility (the first `Result` vs. the second `Result`). Note: the `CrossProcessLockKind::into_guard` method aims at being removed. It's useful now to maintain compatibility but it's “dangerous” as it makes trivial to skip `Clean` vs. `Dirty` states. We ultimately don't want that.
Matrix Rust SDK
The Matrix Rust SDK is a collection of libraries that make it easier to build Matrix clients in Rust.
Development of the SDK is proudly sponsored and maintained by Element. Element uses the SDK in their next-generation mobile apps Element X on iOS and Android and has plans to introduce it to the web and desktop clients as well.
The SDK is also the basis for multiple Matrix projects and we welcome contributions from all.
Purpose
The SDK takes care of the low-level details like encryption, syncing, and room state, so you can focus on your app's logic and UI. Whether you're writing a small bot, a desktop client, or something in between, the SDK is designed to be flexible, async-friendly, and ready to use out of the box.
Project structure
The Matrix Rust SDK is made up of several crates that build on top of each other. The following crates are expected to be usable as direct dependencies:
- matrix-sdk-ui – A high-level client library that makes it easy to build full-featured UI clients with minimal setup. Check out our reference client, multiverse, for an example.
- matrix-sdk – A mid-level client library, ideal for building bots, custom clients, or higher-level abstractions. You can find example usage in the examples directory.
- matrix-sdk-crypto – A standalone encryption state machine with no network I/O, providing end-to-end encryption support for Matrix clients and libraries. See the crypto tutorial for a step-by-step introduction.
All other crates are effectively internal-only and only structured as crates for organizational purposes and to improve compilation times. Direct usage of them is discouraged.
Status
The library is considered production ready and backs multiple client implementations such as Element X [1] [2], Fractal and iamb. Client developers should feel confident to build upon it.
Bindings
The higher-level crates of the Matrix Rust SDK can be embedded in other environments such as Swift, Kotlin, JavaScript, and Node.js. Check out the bindings/ directory to learn more about how to integrate the SDK into your language of choice.