[−][src]Crate ruma
Types and traits for working with the Matrix protocol.
This crate re-exports things from all of the other ruma crates so you don't have to manually keep all the versions in sync.
Which crates are re-exported can be configured through cargo features. Depending on which parts of Matrix are relevant to you, activate the following features:
client-api
for the client-server APIfederation-api
for the server-server (federation) APIappservice-api
for the application service API
Re-exports
pub use assign::assign; |
pub use js_int::int; |
pub use js_int::uint; |
pub use js_int::Int; |
pub use js_int::UInt; |
Modules
authentication | Common types for authentication. |
directory | Common types for room directory endpoints |
encryption | Common types for encryption related tasks. |
identifiers | Crate ruma_identifiers contains types for Matrix identifiers for events, rooms, room aliases, room versions, and users. |
presence | Common types for the presence module |
push | Common types for the push notifications module |
serde | De-/serialization helpers for other ruma crates |
thirdparty | Common types for the third party networks module |
user_id | Matrix user identifiers. |
Macros
device_id | Shorthand for |
device_key_id | Compile-time checked |
event_id | Compile-time checked |
room_alias_id | Compile-time checked |
room_id | Compile-time checked |
room_version_id | Compile-time checked |
server_key_id | Deprecated Compile-time checked |
server_name | Compile-time checked |
server_signing_key_id | Compile-time checked |
user_id | Compile-time checked |
Structs
DeviceId | A Matrix key ID. |
DeviceKeyId | A key algorithm and a device id, combined with a ':' |
EventId | A Matrix event ID. |
RoomAliasId | A Matrix room alias ID. |
RoomId | A Matrix room ID. |
RoomIdOrAliasId | A Matrix room ID or a Matrix room alias ID. |
ServerName | A Matrix-spec compliant server name. |
UserId | A Matrix user ID. |
Enums
DeviceKeyAlgorithm | The basic key algorithms in the specification. |
RoomVersionId | A Matrix room version ID. |
SigningKeyAlgorithm | The signing key algorithms defined in the Matrix spec. |
Traits
Outgoing | A type that can be sent to another party that understands the matrix protocol. If any of the
fields of |
Type Definitions
ServerSigningKeyId | Algorithm + key name for homeserver signing keys. |
Derive Macros
Outgoing | Derive the |