ruma::api

Trait OutgoingRequest

pub trait OutgoingRequest: Sized + Clone {
    type EndpointError: EndpointError;
    type IncomingResponse: IncomingResponse<EndpointError = Self::EndpointError>;

    const METADATA: Metadata;

    // Required method
    fn try_into_http_request<T>(
        self,
        base_url: &str,
        access_token: SendAccessToken<'_>,
        considering: &SupportedVersions,
    ) -> Result<Request<T>, IntoHttpError>
       where T: Default + BufMut;

    // Provided method
    fn is_supported(considering_versions: &SupportedVersions) -> bool { ... }
}

Available on crate feature api only.

Expand description

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

Required Associated Constants§

Source

const METADATA: Metadata

Metadata about the endpoint.

Required Associated Types§

Source

type EndpointError: EndpointError

A type capturing the expected error conditions the server can return.

Source

type IncomingResponse: IncomingResponse<EndpointError = Self::EndpointError>

Response type returned when the request is successful.

Required Methods§

Source

fn try_into_http_request<T>( self, base_url: &str, access_token: SendAccessToken<'_>, considering: &SupportedVersions, ) -> Result<Request<T>, IntoHttpError>
where T: Default + BufMut,

Tries to convert this request into an http::Request.

On endpoints with authentication, when adequate information isn’t provided through access_token, this could result in an error. It may also fail with a serialization error in case of bugs in Ruma though.

It may also fail if, for every version in considering;

The endpoint is too old, and has been removed in all versions. (EndpointRemoved)
The endpoint is too new, and no unstable path is known for this endpoint. (NoUnstablePath)

Finally, this will emit a warning through tracing if it detects that any version in considering has deprecated this endpoint.

The endpoints path will be appended to the given base_url, for example https://matrix.org. Since all paths begin with a slash, it is not necessary for the base_url to have a trailing slash. If it has one however, it will be ignored.

Provided Methods§

Source

fn is_supported(considering_versions: &SupportedVersions) -> bool

Whether the homeserver advertises support for this endpoint.

Returns true if any version or feature in the given SupportedVersions matches a path in the history of this endpoint, unless the endpoint was removed.

Note that this is likely to return false negatives, since some endpoints don’t specify a stable or unstable feature, and homeservers should not advertise support for a Matrix version unless they support all of its features.

Dyn Compatibility§

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Trait OutgoingRequestCopy item path

Required Associated Constants§

const METADATA: Metadata

Required Associated Types§

type EndpointError: EndpointError

type IncomingResponse: IncomingResponse<EndpointError = Self::EndpointError>

Required Methods§

fn try_into_http_request<T>( self, base_url: &str, access_token: SendAccessToken<'_>, considering: &SupportedVersions, ) -> Result<Request<T>, IntoHttpError>where T: Default + BufMut,

Provided Methods§

fn is_supported(considering_versions: &SupportedVersions) -> bool

Dyn Compatibility§

Implementors§

impl OutgoingRequest for ruma::api::appservice::event::push_events::v1::Request

const METADATA: Metadata = METADATA

type EndpointError = MatrixError

type IncomingResponse = Response

impl OutgoingRequest for ruma::api::appservice::ping::send_ping::v1::Request

const METADATA: Metadata = METADATA

type EndpointError = MatrixError

type IncomingResponse = Response

impl OutgoingRequest for ruma::api::appservice::query::query_room_alias::v1::Request

const METADATA: Metadata = METADATA

type EndpointError = MatrixError

type IncomingResponse = Response

impl OutgoingRequest for ruma::api::appservice::query::query_user_id::v1::Request

const METADATA: Metadata = METADATA

type EndpointError = MatrixError

type IncomingResponse = Response

impl OutgoingRequest for ruma::api::appservice::thirdparty::get_location_for_protocol::v1::Request

const METADATA: Metadata = METADATA

type EndpointError = MatrixError

type IncomingResponse = Response

impl OutgoingRequest for ruma::api::appservice::thirdparty::get_location_for_room_alias::v1::Request

const METADATA: Metadata = METADATA

type EndpointError = MatrixError

type IncomingResponse = Response

impl OutgoingRequest for ruma::api::appservice::thirdparty::get_protocol::v1::Request

const METADATA: Metadata = METADATA

type EndpointError = MatrixError

type IncomingResponse = Response

impl OutgoingRequest for ruma::api::appservice::thirdparty::get_user_for_protocol::v1::Request

const METADATA: Metadata = METADATA

type EndpointError = MatrixError

type IncomingResponse = Response

impl OutgoingRequest for ruma::api::appservice::thirdparty::get_user_for_user_id::v1::Request

const METADATA: Metadata = METADATA

type EndpointError = MatrixError

type IncomingResponse = Response

impl OutgoingRequest for ruma::api::client::account::add_3pid::v3::Request

const METADATA: Metadata = METADATA

type EndpointError = UiaaResponse

type IncomingResponse = Response

impl OutgoingRequest for ruma::api::client::account::bind_3pid::v3::Request

const METADATA: Metadata = METADATA

type EndpointError = Error

type IncomingResponse = Response

impl OutgoingRequest for ruma::api::client::account::change_password::v3::Request

const METADATA: Metadata = METADATA

type EndpointError = UiaaResponse

type IncomingResponse = Response

impl OutgoingRequest for ruma::api::client::account::check_registration_token_validity::v1::Request

const METADATA: Metadata = METADATA

type EndpointError = Error

type IncomingResponse = Response

impl OutgoingRequest for ruma::api::client::account::deactivate::v3::Request

const METADATA: Metadata = METADATA

type EndpointError = UiaaResponse

type IncomingResponse = Response

impl OutgoingRequest for ruma::api::client::account::delete_3pid::v3::Request

const METADATA: Metadata = METADATA

type EndpointError = Error

type IncomingResponse = Response

impl OutgoingRequest for ruma::api::client::account::get_3pids::v3::Request

const METADATA: Metadata = METADATA

type EndpointError = Error

type IncomingResponse = Response

impl OutgoingRequest for ruma::api::client::account::get_username_availability::v3::Request

const METADATA: Metadata = METADATA

type EndpointError = Error

type IncomingResponse = Response

Trait OutgoingRequest

fn try_into_http_request<T>( self, base_url: &str, access_token: SendAccessToken<'_>, considering: &SupportedVersions, ) -> Result<Request<T>, IntoHttpError>
where T: Default + BufMut,