Struct EventContextResult

#[non_exhaustive]
pub struct EventContextResult {
    pub end: Option<String>,
    pub events_after: Vec<Raw<AnyTimelineEvent>>,
    pub events_before: Vec<Raw<AnyTimelineEvent>>,
    pub profile_info: BTreeMap<OwnedUserId, UserProfile>,
    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.

Context for search results, if requested.

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.

end: Option<String>

Pagination token for the end of the chunk.

events_after: Vec<Raw<AnyTimelineEvent>>

Events just after the result.

events_before: Vec<Raw<AnyTimelineEvent>>

Events just before the result.

profile_info: BTreeMap<OwnedUserId, UserProfile>

The historic profile information of the users that sent the events returned.

start: Option<String>

Pagination token for the start of the chunk.

Implementations

impl EventContextResult

pub fn new() -> EventContextResult

Creates an empty EventContextResult.

pub fn is_empty(&self) -> bool

Returns whether all fields are None or an empty list.

Trait Implementations

impl Clone for EventContextResult

fn clone(&self) -> EventContextResult

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EventContextResult

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

Formats the value using the given formatter.

impl Default for EventContextResult

fn default() -> EventContextResult

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for EventContextResult

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for EventContextResult

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.