Struct ruma::api::client::search::search_events::v3::IncomingCriteria

pub struct IncomingCriteria {
    pub search_term: String,
    pub keys: Option<Vec<SearchKeys, Global>>,
    pub filter: IncomingRoomEventFilter,
    pub order_by: Option<OrderBy>,
    pub event_context: EventContext,
    pub include_state: Option<bool>,
    pub groupings: IncomingGroupings,
}

Available on (crate features client-api-c or client-api-s) and (crate features client or server) and crate feature api only.

‘Incoming’ variant of Criteria.

Fields

search_term: String

The string to search events for.

keys: Option<Vec<SearchKeys, Global>>

The keys to search for.

Defaults to all keys.

filter: IncomingRoomEventFilter

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

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

Trait Implementations

impl Debug for IncomingCriteria

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for IncomingCriteria

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

Deserialize this value from the given Serde deserializer.