Struct ruma_client_api::message::get_message_events::v3::Request

#[non_exhaustive]
pub struct Request {
    pub room_id: OwnedRoomId,
    pub from: Option<String>,
    pub to: Option<String>,
    pub dir: Direction,
    pub limit: UInt,
    pub filter: RoomEventFilter,
}

Request type for the get_message_events endpoint.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

room_id: OwnedRoomId

The room to get events from.

from: Option<String>

The token to start returning events from.

This token can be obtained from a prev_batch token returned for each room by the sync endpoint, or from a start or end token returned by a previous request to this endpoint.

If this is None, the server will return messages from the start or end of the history visible to the user, depending on the value of dir.

to: Option<String>

The token to stop returning events at.

This token can be obtained from a prev_batch token returned for each room by the sync endpoint, or from a start or end token returned by a previous request to this endpoint.

dir: Direction

The direction to return events from.

limit: UInt

The maximum number of events to return.

Default: 10.

filter: RoomEventFilter

A RoomEventFilter to filter returned events with.

Implementations

impl Request

pub fn new(room_id: OwnedRoomId, dir: Direction) -> Self

Creates a new Request with the given room ID and direction.

All other parameters will be defaulted.

pub fn backward(room_id: OwnedRoomId) -> Self

Creates a new Request with the given room ID and dir set to Backward.

If the returned request is sent without from being set, pagination will start at the end of (the accessible part of) the room timeline.

Example

let request = get_message_events::v3::Request::backward(room_id).from(token);

pub fn forward(room_id: OwnedRoomId) -> Self

Creates a new Request with the given room ID and dir set to Forward.

If the returned request is sent without from being set, pagination will start at the beginning of (the accessible part of) the room timeline.

Example

let request = get_message_events::v3::Request::forward(room_id).from(token);

pub fn from(self, from: impl Into<Option<String>>) -> Self

Creates a new Request from self with the from field set to the given value.

Since the field is public, you can also assign to it directly. This method merely acts as a shorthand for that, because it is very common to set this field.

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 OutgoingRequest for Request

type EndpointError = Error

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

type IncomingResponse = Response

Response type returned when the request is successful.

const METADATA: Metadata = METADATA

Metadata about the endpoint.

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.