Struct ruma_common::api::Metadata

source ·
pub struct Metadata {
    pub method: Method,
    pub rate_limited: bool,
    pub authentication: AuthScheme,
    pub history: VersionHistory,
}
Available on crate feature api only.
Expand description

Metadata about an API endpoint.

Fields§

§method: Method

The HTTP method used by this endpoint.

§rate_limited: bool

Whether or not this endpoint is rate limited by the server.

§authentication: AuthScheme

What authentication scheme the server uses for this endpoint.

§history: VersionHistory

All info pertaining to an endpoint’s (historic) paths, deprecation version, and removal.

Implementations§

Returns an empty request body for this Matrix request.

For GET requests, it returns an entirely empty buffer, for others it returns an empty JSON object ({}).

Transform the SendAccessToken into an access token if the endpoint requires it, or if it is SendAccessToken::Force.

Fails if the endpoint requires an access token but the parameter is SendAccessToken::None, or if the access token can’t be converted to a HeaderValue.

Generate the endpoint URL for this endpoint.

Trait Implementations§

Returns a copy of the value. Read more
Performs copy-assignment from source. Read more
Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Gets the TypeId of self. Read more
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

The alignment of pointer.
The type for initializers.
Initializes a with the given initializer. Read more
Dereferences the given pointer. Read more
Mutably dereferences the given pointer. Read more
Drops the object pointed to by the given pointer. Read more
The resulting type after obtaining ownership.
Creates owned data from borrowed data, usually by cloning. Read more
Uses borrowed data to replace owned data, usually by cloning. Read more
The type returned in the event of a conversion error.
Performs the conversion.
The type returned in the event of a conversion error.
Performs the conversion.
Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more