Struct ruma_client_api::search::search_events::v3::IncomingCriteria
source · [−]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,
}
Available on crate features
client
or server
only.Expand description
‘Incoming’ variant of Criteria.
Fields
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
sourceimpl Debug for IncomingCriteria
impl Debug for IncomingCriteria
sourceimpl<'de> Deserialize<'de> for IncomingCriteria
impl<'de> Deserialize<'de> for IncomingCriteria
sourcefn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::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
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more