Module ruma::api

source ·
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.
  • 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.

Macros§

Structs§

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

Enums§

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

Traits§

Attribute Macros§

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