Struct ResultRoomEvents

#[non_exhaustive]
pub struct ResultRoomEvents {
    pub count: Option<UInt>,
    pub groups: BTreeMap<GroupingKey, BTreeMap<OwnedRoomIdOrUserId, ResultGroup>>,
    pub next_batch: Option<String>,
    pub results: Vec<SearchResult>,
    pub state: BTreeMap<OwnedRoomId, Vec<Raw<AnyStateEvent>>>,
    pub highlights: Vec<String>,
}

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

Categories of events that can be searched for.

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.

count: Option<UInt>

An approximate count of the total number of results found.

groups: BTreeMap<GroupingKey, BTreeMap<OwnedRoomIdOrUserId, ResultGroup>>

Any groups that were requested.

next_batch: Option<String>

Token that can be used to get the next batch of results, by passing as the next_batch parameter to the next call.

If this field is absent, there are no more results.

results: Vec<SearchResult>

List of results in the requested order.

state: BTreeMap<OwnedRoomId, Vec<Raw<AnyStateEvent>>>

The current state for every room in the results.

This is included if the request had the include_state key set with a value of true.

highlights: Vec<String>

List of words which should be highlighted, useful for stemming which may change the query terms.

Implementations

impl ResultRoomEvents

pub fn new() -> ResultRoomEvents

Creates an empty ResultRoomEvents.

pub fn is_empty(&self) -> bool

Returns true if all fields are empty / None.

Trait Implementations

impl Clone for ResultRoomEvents

fn clone(&self) -> ResultRoomEvents

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ResultRoomEvents

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

Formats the value using the given formatter.

impl Default for ResultRoomEvents

fn default() -> ResultRoomEvents

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ResultRoomEvents

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ResultRoomEvents

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.