Module api 

Available on crate feature api only.

Core types used to define the requests and responses for each endpoint in the various Matrix API specifications.

When implementing a new Matrix API, each endpoint has a request type which implements IncomingRequest and OutgoingRequest, and a response type connected via an associated type.

An implementation of IncomingRequest or OutgoingRequest contains all the information about the HTTP method, the path and input parameters for requests, and the structure of a successful response. Such types can then be used by client code to make requests, and by server code to fulfill those requests.

Modules

auth_scheme

The AuthScheme trait used to specify the authentication scheme used by endpoints and the types that implement it.

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.

path_builder

The PathBuilder trait used to construct the path used to query endpoints and the types that implement it.

Macros

metadata

Convenient constructor for Metadata implementation.

Structs

AppserviceUserIdentity

Data to assert the identity of an appservice virtual user.

BytesBody

Raw-bytes body type, used for some media endpoints.

EmptyBody

“Empty” body type, used mostly for GET requests.

SupportedVersions

The list of Matrix versions and features supported by a homeserver.

Enums

Direction

The direction to return events from.

FeatureFlag

The Matrix features supported by Ruma.

MatrixVersion

The Matrix versions Ruma currently understands to exist.

Traits

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.

IncomingResponseExt

Convenience functionality on top of IncomingResponse.

Metadata

Metadata about an API endpoint.

OutgoingBody

HTTP message body pre-serialization.

OutgoingRequest

A request type for a Matrix API endpoint, used for sending requests.

OutgoingRequestAppserviceExt

An extension to OutgoingRequest which provides Appservice specific methods.

OutgoingRequestExt

Convenience functionality on top of OutgoingRequest.

OutgoingResponse

A request type for a Matrix API endpoint, used for sending responses.

Attribute Macros

request

Generates OutgoingRequest and IncomingRequest implementations.

response

Generates OutgoingResponse and IncomingResponse implementations.

Derive Macros

OutgoingBodyJson

Implement OutgoingBody in terms of ruma_common::serde::json_to_buf.