Struct ruma_client_api::search::search_events::v3::IncomingCriteria

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

‘Incoming’ variant of Criteria.

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

Formats the value using the given formatter.

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

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

Deserialize this value from the given Serde deserializer.