Struct ruma::api::client::r0::search::search_events::Criteria

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>,
}

This is supported on crate feature api and (crate features client-api or client-api-c or client-api-s) only.

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

impl<'a> Criteria<'a>

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

Creates a new Criteria with the given search term.

Trait Implementations

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

pub 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>

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

Formats the value using the given formatter.

impl<'a> Outgoing for Criteria<'a>

type Incoming = IncomingCriteria

The ‘Incoming’ variant of Self.

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

pub 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.