Ruma

ruma-client

ruma-client is a bare-bones Matrix client library with support for all of the r0.6.0 client-server API, but without any bookkeeping apart from storing authentication data.

Matrix API crates

These crates (Rust parlance for packages) contain endpoint definitions for the various Matrix APIs. They can be used both for clients (ruma-client, matrix-rust-sdk) as well as servers (Conduit, Maelstrom).

ruma-client-api

ruma-client-api contains serializable types for the requests and responses for each endpoint in the Matrix client API specification.

ruma-appservice-api

ruma-appservice-api contains serializable types for the requests and responses for each endpoint in the Matrix appservice API specification.

ruma-federation-api

ruma-federation-api contains serializable types for the requests and responses for endpoints in the Matrix server-server (federation) API specification. As of the time of writing (15.05.2020), it is still very incomplete.

Foundational crates

These crates are the foundation for the API crates above and other Matrix-related applications written in Rust.

ruma-api

ruma-api contains core types used to define the requests and responses for each endpoint in the various Matrix API specifications. These types can be shared by client and server code for all Matrix APIs.

ruma-identifiers

ruma-identifiers contains types for user IDs, room IDs and other identifiers defined by the Matrix API specifications.

ruma-events

ruma-events contains serializable types for the events in the Matrix specification.

ruma-signatures

ruma-signatures contains implementations of cryptographic signing, hashing and verification algorithms defined by the Matrix specification.