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

pub struct Request {
    pub room_id: RoomId,
    pub from: String,
    pub to: Option<String>,
    pub dir: Direction,
    pub limit: Option<UInt>,
    pub filter: Option<RoomEventFilter>,
}

Data for a request to the get_message_events API endpoint.

Get message events for a room.

Fields

room_id: RoomId

The room to get events from.

from: 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 API, or from a start or end token returned by a previous request to this endpoint.

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

The maximum number of events to return.

Default: 10.

filter: Option<RoomEventFilter>

A RoomEventFilter to filter returned events with.

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

type Response = Response

Data returned in a successful response from the endpoint.

type ResponseError = Error

Error type returned when response from endpoint fails.

const METADATA: Metadata

Metadata for the #name endpoint.

impl Outgoing for Request

type Incoming = Self

The 'Incoming' variant of Self.

impl TryFrom<Request<Vec<u8>>> for Request

type Error = FromHttpRequestError

The type returned in the event of a conversion error.

fn try_from(request: Request<Vec<u8>>) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Request> for Request<Vec<u8>>

type Error = IntoHttpError

The type returned in the event of a conversion error.

fn try_from(request: Request) -> Result<Self, Self::Error>

Performs the conversion.