Struct ruma_client_api::search::search_events::v3::ResultRoomEvents
source · [−]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 features
client
or server
only.Expand description
Categories of events that can be searched for.
Fields
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
Trait Implementations
sourceimpl Clone for ResultRoomEvents
impl Clone for ResultRoomEvents
sourcefn clone(&self) -> ResultRoomEvents
fn clone(&self) -> ResultRoomEvents
Returns a copy of the value. Read more
1.0.0 · sourceconst fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moresourceimpl Debug for ResultRoomEvents
impl Debug for ResultRoomEvents
sourceimpl Default for ResultRoomEvents
impl Default for ResultRoomEvents
sourcefn default() -> ResultRoomEvents
fn default() -> ResultRoomEvents
Returns the “default value” for a type. Read more
sourceimpl<'de> Deserialize<'de> for ResultRoomEvents
impl<'de> Deserialize<'de> for ResultRoomEvents
sourcefn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
sourceimpl Serialize for ResultRoomEvents
impl Serialize for ResultRoomEvents
Auto Trait Implementations
impl RefUnwindSafe for ResultRoomEvents
impl Send for ResultRoomEvents
impl Sync for ResultRoomEvents
impl Unpin for ResultRoomEvents
impl UnwindSafe for ResultRoomEvents
Blanket Implementations
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more