Struct matrix_sdk_base::ruma::api::client::search::search_events::v3::Criteria

#[non_exhaustive]
pub struct Criteria {
    pub search_term: String,
    pub keys: Option<Vec<SearchKeys>>,
    pub filter: RoomEventFilter,
    pub order_by: Option<OrderBy>,
    pub event_context: EventContext,
    pub include_state: Option<bool>,
    pub groupings: Groupings,
}

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: String

The string to search events for.

keys: Option<Vec<SearchKeys>>

The keys to search for.

Defaults to all keys.

filter: RoomEventFilter

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

Requests that the server partitions the result set based on the provided list of keys.

Implementations

impl Criteria

pub fn new(search_term: String) -> Criteria

Creates a new Criteria with the given search term.

Trait Implementations

impl Clone for Criteria

fn clone(&self) -> Criteria

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Criteria

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Criteria

fn deserialize<__D>( __deserializer: __D, ) -> Result<Criteria, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Criteria

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

where __S: Serializer,

Serialize this value into the given Serde serializer.