Struct ruma_client_api::r0::message::get_message_events::Request

#[non_exhaustive]pub struct Request<'a> {
    pub room_id: &'a RoomId,
    pub from: &'a str,
    pub to: Option<&'a str>,
    pub dir: Direction,
    pub limit: UInt,
    pub filter: Option<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: &'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 API, or from a start or end token returned by a previous request to this endpoint.

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: Option<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.

Trait Implementations

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

impl<'a> Outgoing for Request<'a>

type Incoming = IncomingRequest

The 'Incoming' variant of Self.

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

type EndpointError = Error

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

type IncomingResponse = <Response as Outgoing>::Incoming

Response type returned when the request is successful.

pub const METADATA: Metadata

Metadata for the get_message_events API endpoint.

pub fn try_into_http_request(
    self,
    base_url: &str,
    access_token: Option<&str>
) -> Result<Request<Vec<u8>>, IntoHttpError>

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