Struct ruma_federation_api::event::get_missing_events::v1::Request

pub struct Request {
    pub room_id: OwnedRoomId,
    pub limit: UInt,
    pub min_depth: UInt,
    pub earliest_events: Vec<OwnedEventId>,
    pub latest_events: Vec<OwnedEventId>,
}

Request type for the get_missing_events endpoint.

Fields

room_id: OwnedRoomId

The room ID to search in.

limit: UInt

The maximum number of events to retrieve.

Defaults to 10.

min_depth: UInt

The minimum depth of events to retrieve.

Defaults to 0.

earliest_events: Vec<OwnedEventId>

The latest event IDs that the sender already has.

These are skipped when retrieving the previous events of latest_events.

latest_events: Vec<OwnedEventId>

The event IDs to retrieve the previous events for.

Implementations

impl Request

pub fn new( room_id: OwnedRoomId, earliest_events: Vec<OwnedEventId>, latest_events: Vec<OwnedEventId>, ) -> Self

Creates a new Request for events in the given room with the given constraints.

Trait Implementations

impl Clone for Request

fn clone(&self) -> Request

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Request

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl IncomingRequest for Request

Available on crate feature server only.

const METADATA: Metadata = METADATA

Metadata about the endpoint.

type EndpointError = MatrixError

A type capturing the error conditions that can be returned in the response.

type OutgoingResponse = Response

Response type to return when the request is successful.

fn try_from_http_request<B, S>( request: Request<B>, path_args: &[S], ) -> Result<Self, FromHttpRequestError>

where B: AsRef<[u8]>, S: AsRef<str>,

Tries to turn the given http::Request into this request type, together with the corresponding path arguments.

impl OutgoingRequest for Request

Available on crate feature client only.

const METADATA: Metadata = METADATA

Metadata about the endpoint.

type EndpointError = MatrixError

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

type IncomingResponse = Response

Response type returned when the request is successful.

fn try_into_http_request<T: Default + BufMut>( self, base_url: &str, access_token: SendAccessToken<'_>, considering_versions: &[MatrixVersion], ) -> Result<Request<T>, IntoHttpError>

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