Struct ruma_client_api::search::search_events::v3::Criteria

#[non_exhaustive]
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>,
}

Criteria for searching a category of events.

Fields (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.

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

impl<'a> Criteria<'a>

pub fn new(search_term: &'a str) -> Self

Creates a new Criteria with the given search term.

Trait Implementations

impl<'a> Clone for Criteria<'a>

fn clone(&self) -> Criteria<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Criteria<'a>

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

Formats the value using the given formatter.

impl<'a> Serialize for Criteria<'a>

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

Serialize this value into the given Serde serializer.