Struct ruma_client_api::r0::search::search_events::Criteria [−][src]
pub struct Criteria<'a> { pub search_term: &'a str, pub keys: Option<&'a [SearchKeys]>, pub filter: Option<RoomEventFilter<'a>>, pub order_by: Option<OrderBy>, pub event_context: EventContext, pub include_state: Option<bool>, pub groupings: Groupings<'a>, }
Expand description
Criteria for searching a category of events.
Fields
search_term: &'a str
The string to search events for.
keys: Option<&'a [SearchKeys]>
The keys to search for. Defaults to all keys.
filter: Option<RoomEventFilter<'a>>
A Filter
to apply to the search.
order_by: Option<OrderBy>
The order in which to search for results.
event_context: EventContext
Configures whether any context for the events returned are included in the response.
include_state: Option<bool>
Requests the server return the current state for each room returned.
groupings: Groupings<'a>
Requests that the server partitions the result set based on the provided list of keys.
Implementations
Trait Implementations
Auto Trait Implementations
impl<'a> RefUnwindSafe for Criteria<'a>
impl<'a> UnwindSafe for Criteria<'a>
Blanket Implementations
Mutably borrows from an owned value. Read more
Instruments this type with the provided Span
, returning an
Instrumented
wrapper. Read more