Struct ruma::api::client::r0::search::search_events::IncomingCriteria [−][src]
pub struct IncomingCriteria { pub search_term: String, pub keys: Option<Vec<SearchKeys, Global>>, pub filter: Option<IncomingRoomEventFilter>, pub order_by: Option<OrderBy>, pub event_context: EventContext, pub include_state: Option<bool>, pub groupings: IncomingGroupings, }
api
and (crate features client-api
or client-api-c
or client-api-s
) only.Expand description
‘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: Option<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
pub fn deserialize<__D>(
__deserializer: __D
) -> Result<IncomingCriteria, <__D as Deserializer<'de>>::Error> where
__D: Deserializer<'de>,
pub fn deserialize<__D>(
__deserializer: __D
) -> Result<IncomingCriteria, <__D as Deserializer<'de>>::Error> where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
Auto Trait Implementations
impl RefUnwindSafe for IncomingCriteria
impl Send for IncomingCriteria
impl Sync for IncomingCriteria
impl Unpin for IncomingCriteria
impl UnwindSafe for IncomingCriteria
Blanket Implementations
Mutably borrows from an owned value. Read more
Instruments this type with the provided Span
, returning an
Instrumented
wrapper. Read more
Instruments this type with the provided Span
, returning an
Instrumented
wrapper. Read more
type Output = T
type Output = T
Should always be Self
pub fn vzip(self) -> V
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more