Module ruma::api [−][src]
api only.Expand description
(De)serializable types for various Matrix APIs requests and responses and abstractions for them.
Modules
| appservice | appservice-api or appservice-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 or client-api-c or client-api-s(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. |
| federation | federation-api or federation-api-c or federation-api-s(De)serializable types for the Matrix Server-Server API. These types are used by server code. |
| identity_service | identity-service-api or identity-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_gateway | push-gateway-api or push-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. |
Macros
| ruma_api |
Structs
| Metadata | Metadata about an API endpoint. |
Enums
| AuthScheme | Authentication scheme used by the endpoint. |
| SendAccessToken | An enum to control whether an access token should be added to outgoing requests |
Traits
| EndpointError | Gives users the ability to define their own serializable / deserializable errors. |
| IncomingNonAuthRequest | Marker trait for requests that don’t require authentication, for the server side. |
| 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. |
| OutgoingNonAuthRequest | Marker trait for requests that don’t require authentication, for the client side. |
| OutgoingRequest | A request type for a Matrix API endpoint, used for sending requests. |
| OutgoingRequestAppserviceExt | An extension to |
| OutgoingResponse | A request type for a Matrix API endpoint, used for sending responses. |