Struct ruma_client_api::message::get_message_events::v3::IncomingRequest

pub struct IncomingRequest {
    pub room_id: Box<RoomId>,
    pub from: String,
    pub to: Option<String>,
    pub dir: Direction,
    pub limit: UInt,
    pub filter: IncomingRoomEventFilter,
}

‘Incoming’ variant of Request.

Fields

room_id: Box<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: UInt

The maximum number of events to return.

Default: 10.

filter: IncomingRoomEventFilter

A RoomEventFilter to filter returned events with.

Trait Implementations

impl Debug for IncomingRequest

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

Formats the value using the given formatter.

impl IncomingRequest for IncomingRequest

This is supported on crate feature server only.

type EndpointError = Error

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.

const METADATA: Metadata

Metadata about the endpoint.

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.