[]Struct matrix_sdk_base::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) -> Request<'a>

Creates a new Request with the given parameters.

All other parameters will be defaulted.

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

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) -> Request<'a>

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>

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

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.

Auto Trait Implementations

impl<'a> RefUnwindSafe for Request<'a>[src]

impl<'a> Send for Request<'a>[src]

impl<'a> Sync for Request<'a>[src]

impl<'a> Unpin for Request<'a>[src]

impl<'a> UnwindSafe for Request<'a>[src]

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> AsyncTraitDeps for T where
    T: Send + Sync + Debug
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> Conv for T

impl<T> Conv for T

impl<T> FmtForward for T

impl<T> From<T> for T[src]

impl<T> Instrument for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> Pipe for T where
    T: ?Sized

impl<T> Pipe for T

impl<T> PipeAsRef for T

impl<T> PipeBorrow for T

impl<T> PipeDeref for T

impl<T> PipeRef for T

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<T> Tap for T

impl<T> Tap for T

impl<T, U> TapAsRef<U> for T where
    U: ?Sized

impl<T, U> TapBorrow<U> for T where
    U: ?Sized

impl<T> TapDeref for T

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<T> TryConv for T

impl<T> TryConv for T

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

impl<V, T> VZip<V> for T where
    V: MultiLane<T>,