Struct PaginationChunk

#[non_exhaustive]
pub struct PaginationChunk {
    pub chunk: Vec<Raw<AnyTimelineEvent>>,
    pub end: String,
    pub start: Option<String>,
}

Available on (crate features client-api-c or client-api-s) and (crate features client or server) and crate feature api only.

A paginated chunk of messages from the room’s timeline.

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.

chunk: Vec<Raw<AnyTimelineEvent>>

An array of events.

If the user is a member of the room this will be a list of the most recent messages for this room.

If the user has left the room this will be the messages that preceded them leaving.

end: String

A token which correlates to the end of chunk.

Can be passed to listen_to_new_events to listen to new events and to get_message_events to retrieve later events.

start: Option<String>

A token which correlates to the start of chunk. Can be passed to get_message_events to retrieve earlier events.

If no earlier events are available, this property may be omitted from the response.

Implementations

impl PaginationChunk

pub fn new(chunk: Vec<Raw<AnyTimelineEvent>>, end: String) -> PaginationChunk

Construct a new PaginationChunk with the given events and end token.

Trait Implementations

impl Clone for PaginationChunk

fn clone(&self) -> PaginationChunk

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PaginationChunk

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PaginationChunk

fn deserialize<__D>( __deserializer: __D, ) -> Result<PaginationChunk, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for PaginationChunk

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.