Crate ruma_api

Crate 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.

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

An implementation of Endpoint 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

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.

Macros

ruma_api

Generates a ruma_api::Endpoint from a concise definition.

Structs

Metadata

Metadata about an API endpoint.

Traits

Endpoint	A Matrix API endpoint.
EndpointError	Gives users the ability to define their own serializable/deserializable errors.