Struct ruma_client_api::search::search_events::v3::Criteria
source · [−]pub struct Criteria<'a> {
pub search_term: &'a str,
pub keys: Option<&'a [SearchKeys]>,
pub filter: RoomEventFilter<'a>,
pub order_by: Option<OrderBy>,
pub event_context: EventContext,
pub include_state: Option<bool>,
pub groupings: Groupings<'a>,
}
Available on crate features
client
or server
only.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: 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> Send for Criteria<'a>
impl<'a> Sync for Criteria<'a>
impl<'a> Unpin for Criteria<'a>
impl<'a> UnwindSafe for Criteria<'a>
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