Module api

Available on crate feature api only.

Expand description

(De)serializable types for various Matrix APIs requests and responses and abstractions for them.

Modules§

appserviceappservice-api-c or appservice-api-s: (De)serializable types for the Matrix Application Service API. These types can be shared by application service and server code.
client(client-api-c or client-api-s) and (client or server): (De)serializable types for the Matrix Client-Server API. These types can be shared by client and server code.
error: This module contains types for all kinds of errors that can occur when converting between http requests / responses and ruma’s representation of matrix API requests / responses.
federationfederation-api-c or federation-api-s: (De)serializable types for the Matrix Server-Server API. These types are used by server code.
identity_serviceidentity-service-api-c or identity-service-api-s: (De)serializable types for the Matrix Identity Service API. These types can be shared by client and identity service code.
push_gatewaypush-gateway-api-c or push-gateway-api-s: (De)serializable types for the Matrix Push Gateway API. These types can be shared by push gateway and server code.

Metadata: Metadata about an API endpoint.
VersionHistory: The complete history of this endpoint as far as Ruma knows, together with all variants on versions stable and unstable.

AuthScheme: Authentication scheme used by the endpoint.
Direction: The direction to return events from.
MatrixVersion: The Matrix versions Ruma currently understands to exist.
SendAccessToken: An enum to control whether an access token should be added to outgoing requests
VersioningDecision: A versioning “decision” derived from a set of Matrix versions.

EndpointError: Gives users the ability to define their own serializable / deserializable errors.
IncomingRequest: A request type for a Matrix API endpoint, used for receiving requests.
IncomingResponse: A response type for a Matrix API endpoint, used for receiving responses.
OutgoingRequest: A request type for a Matrix API endpoint, used for sending requests.
OutgoingRequestAppserviceExt: An extension to OutgoingRequest which provides Appservice specific methods.
OutgoingResponse: A request type for a Matrix API endpoint, used for sending responses.

request: ⚠ If this is the only documentation you see, please navigate to the docs for ruma_common::api::request, where actual documentation can be found.
response: ⚠ If this is the only documentation you see, please navigate to the docs for ruma_common::api::response, where actual documentation can be found.