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

#[non_exhaustive]
pub struct Request<'a> {
    pub room_id: &'a RoomId,
    pub from: Option<&'a str>,
    pub to: Option<&'a str>,
    pub dir: Direction,
    pub limit: UInt,
    pub filter: RoomEventFilter<'a>,
}

Data for a request to the get_message_events API endpoint.

Get message events for a room.

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: &'a RoomId

The room to get events from.

from: Option<&'a str>

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.

Note: This field is marked required in v1.2 of the specification, but that is changing, most likely as part of v1.3. To frontload the breaking change, this field is optional already even though v1.2 is the latest version at the time of writing. The specification change can be found here.

to: Option<&'a str>

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>

A RoomEventFilter to filter returned events with.

Implementations

impl<'a> Request<'a>

pub fn new(room_id: &'a RoomId, from: &'a str, dir: Direction) -> Self

Creates a new Request with the given parameters.

All other parameters will be defaulted.

pub fn backward(room_id: &'a RoomId, from: &'a str) -> Self

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

pub fn forward(room_id: &'a RoomId, from: &'a str) -> Self

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

pub fn from_start(room_id: &'a RoomId) -> Self

Creates a new Request to fetch messages from the very start of the available history for a given room.

pub fn from_end(room_id: &'a RoomId) -> Self

Creates a new Request to fetch messages from the very end of the available history for a given room.

Trait Implementations

impl<'a> Clone for Request<'a>

fn clone(&self) -> Request<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Request<'a>

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

Formats the value using the given formatter.

impl<'a> OutgoingRequest for Request<'a>

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 = self::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.