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

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

‘Incoming’ variant of Request.

Fields

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.

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<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

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