Struct ruma_client_api::search::search_events::v3::ResultRoomEvents
source · #[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>,
}
Expand description
Categories of events that can be searched for.
Fields (Non-exhaustive)§
This struct is marked as 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§
Trait Implementations§
source§impl Clone for ResultRoomEvents
impl Clone for ResultRoomEvents
source§fn clone(&self) -> ResultRoomEvents
fn clone(&self) -> ResultRoomEvents
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moresource§impl Debug for ResultRoomEvents
impl Debug for ResultRoomEvents
source§impl Default for ResultRoomEvents
impl Default for ResultRoomEvents
source§fn default() -> ResultRoomEvents
fn default() -> ResultRoomEvents
Returns the “default value” for a type. Read more
source§impl<'de> Deserialize<'de> for ResultRoomEvents
impl<'de> Deserialize<'de> for ResultRoomEvents
source§fn 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
Auto Trait Implementations§
impl Freeze for ResultRoomEvents
impl RefUnwindSafe for ResultRoomEvents
impl Send for ResultRoomEvents
impl Sync for ResultRoomEvents
impl Unpin for ResultRoomEvents
impl UnwindSafe for ResultRoomEvents
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
🔬This is a nightly-only experimental API. (
clone_to_uninit
)