Struct ruma_client_api::search::search_events::v3::Criteria
source · #[non_exhaustive]pub struct Criteria {
pub search_term: String,
pub keys: Option<Vec<SearchKeys>>,
pub filter: RoomEventFilter,
pub order_by: Option<OrderBy>,
pub event_context: EventContext,
pub include_state: Option<bool>,
pub groupings: Groupings,
}
Expand description
Criteria for searching a category of events.
Fields (Non-exhaustive)§
This struct is marked as 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: RoomEventFilter
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
Requests that the server partitions the result set based on the provided list of keys.
Implementations§
Trait Implementations§
source§impl<'de> Deserialize<'de> for Criteria
impl<'de> Deserialize<'de> for Criteria
source§fn 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 Freeze for Criteria
impl RefUnwindSafe for Criteria
impl Send for Criteria
impl Sync for Criteria
impl Unpin for Criteria
impl UnwindSafe for Criteria
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
🔬This is a nightly-only experimental API. (
clone_to_uninit
)