Struct ruma_client_api::r0::search::search_events::RoomEventResults

pub struct RoomEventResults {
    pub count: UInt,
    pub groups: HashMap<GroupingKey, HashMap<RoomId, ResultGroup>>,
    pub next_batch: Option<String>,
    pub results: Vec<SearchResult>,
    pub state: Option<()>,
}

Categories of events that can be searched for.

Fields

count: UInt

An approximate count of the total number of results found.

groups: HashMap<GroupingKey, HashMap<RoomId, 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: Option<()>

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.

Trait Implementations

impl Clone for RoomEventResults

fn clone(&self) -> RoomEventResults

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RoomEventResults

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Outgoing for RoomEventResults

type Incoming = IncomingRoomEventResults

The 'Incoming' variant of Self.

impl Serialize for RoomEventResults

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

Serialize this value into the given Serde serializer.