Crate ruma_common
source ·Expand description
Common types for the Ruma crates.
Re-exports§
pub use self::canonical_json::CanonicalJsonError;
pub use self::canonical_json::CanonicalJsonObject;
pub use self::canonical_json::CanonicalJsonValue;
Modules§
- Core types used to define the requests and responses for each endpoint in the various Matrix API specifications.
- Common types for authentication.
- Canonical JSON types and related functions.
- Common types for room directory endpoints.
- Common types for encryption related tasks.
- Helpers for HTTP headers.
- Matrix URIs.
- Common types and functions for the content repository.
- Common types for the
m.room.power_levels
event. - Common types for the presence module.
- Common types for the push notifications module.
- Common types for rooms.
- (De)serialization helpers for other Ruma crates.
- Common types for spaces.
- Common types for the third party networks module.
- Common types for the Send-To-Device Messaging
- Matrix user identifiers.
Macros§
- Shorthand for
<&DeviceId>::from
. - Compile-time checked
DeviceKeyId
construction. - Compile-time checked
EventId
construction. - Convenient constructor for
Metadata
constants. - Compile-time checked
MxcUri
construction. - Shorthand for
OwnedDeviceId::from
. - Compile-time checked
OwnedDeviceKeyId
construction. - Compile-time checked
OwnedEventId
construction. - Compile-time checked
OwnedMxcUri
construction. - Compile-time checked
OwnedRoomAliasId
construction. - Compile-time checked
OwnedRoomId
construction. - Compile-time checked
OwnedServerName
construction. - Compile-time checked
OwnedServerSigningKeyId
construction. - Compile-time checked
OwnedSessionId
construction. - Compile-time checked
OwnedUserId
construction. - Compile-time checked
RoomAliasId
construction. - Compile-time checked
RoomId
construction. - Compile-time checked
RoomVersionId
construction. - Compile-time checked
ServerName
construction. - Compile-time checked
ServerSigningKeyId
construction. - Compile-time checked
SessionId
construction. - Compile-time checked
UserId
construction.
Structs§
- A client secret.
- A Matrix key ID.
- A key algorithm and a device id, combined with a ‘:’.
- A Matrix event ID.
- A key algorithm and key name delimited by a colon.
- A Matrix key identifier.
- The
matrix.to
URI representation of a user, room or event. - The
matrix:
URI representation of a user, room or event. - A timestamp represented as the number of milliseconds since the unix epoch.
- A URI that should be a Matrix-spec compliant MXC URI.
- Owned variant of ClientSecret
- Owned variant of DeviceId
- Owned variant of DeviceKeyId
- Owned variant of EventId
- Owned variant of KeyId
- Owned variant of KeyName
- Owned variant of MxcUri
- Owned variant of RoomAliasId
- Owned variant of RoomId
- Owned variant of RoomOrAliasId
- Owned variant of ServerName
- Owned variant of SessionId
- Owned variant of TransactionId
- Owned variant of UserId
- Owned variant of VoipId
- A Matrix room alias ID.
- A Matrix room ID.
- A Matrix room ID or a Matrix room alias ID.
- A timestamp represented as the number of seconds since the unix epoch.
- A Matrix-spec compliant server name.
- A session ID.
- Map of all signatures, grouped by entity
- A Matrix transaction ID.
- A Matrix user ID.
- A VoIP identifier.
Enums§
- The basic key algorithms in the specification.
- An encryption algorithm to be used to encrypt messages sent to a room.
- An error encountered when trying to parse an invalid ID string.
- A key algorithm to be used to generate a key from a passphrase.
- An error occurred while validating a
MatrixId
. - An error occurred while validating a
matrix.to
URI. - An error occurred while validating a
MatrixURI
. - An error occurred while validating an MXC URI.
- A Matrix room version ID.
- The signing key algorithms defined in the Matrix spec.
- A Matrix VoIP version ID.
- An error occurred while validating a
VoipVersionId
.
Type Aliases§
- Map of device signatures for an event, grouped by user.
- Algorithm + key name for device keys.
- Map of key identifier to signature values.
- Algorithm + key name for device keys.
- Algorithm + key name for homeserver signing keys.
- Algorithm + key name for signing keys.
- Map of server signatures for an event, grouped by server.
- Algorithm + key name for homeserver signing keys.
- Algorithm + key name for signing keys.