Struct Timeline

#[non_exhaustive]
pub struct Timeline {
    pub limited: bool,
    pub prev_batch: Option<String>,
    pub events: Vec<Raw<AnySyncTimelineEvent>>,
}

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

Events in the 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.

limited: bool

True if the number of events returned was limited by the limit on the filter.

Default to false.

prev_batch: Option<String>

A token that can be supplied to to the from parameter of the /rooms/{roomId}/messages endpoint.

events: Vec<Raw<AnySyncTimelineEvent>>

A list of events.

Implementations

impl Timeline

pub fn new() -> Timeline

Creates an empty Timeline.

pub fn is_empty(&self) -> bool

Returns true if there are no timeline updates.

A Timeline is considered non-empty if it has at least one event, a prev_batch value, or limited is true.

Trait Implementations

impl Clone for Timeline

fn clone(&self) -> Timeline

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Timeline

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

Formats the value using the given formatter.

impl Default for Timeline

fn default() -> Timeline

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Timeline

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Timeline

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.