Struct ruma_client_api::r0::search::search_events::Criteria

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

Criteria for searching a category of events.

Fields

event_context: Option<EventContext>

Configures whether any context for the events returned are included in the response.

filter: Option<RoomEventFilter>

A Filter to apply to the search.

groupings: Option<Groupings>

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

include_state: Option<bool>

Requests the server return the current state for each room returned.

keys: Vec<SearchKeys>

The keys to search for. Defaults to all keys.

order_by: Option<OrderBy>

The order in which to search for results.

search_term: String

The string to search events for.

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

Formats the value using the given formatter.

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

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::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::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.