Enum matrix_sdk_base::ruma::api::client::search::search_events::v3::OrderBy

#[non_exhaustive]
pub enum OrderBy {
    Recent,
    Rank,
}

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

The order in which to search for results.

This type can hold an arbitrary string. To build this with a custom value, convert it from a string with ::from() / .into(). To check for values that are not available as a documented variant here, use its string representation, obtained through .as_str().

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Recent

Prioritize recent events.

Rank

Prioritize events by a numerical ranking of how closely they matched the search criteria.

Implementations

impl OrderBy

pub fn as_str(&self) -> &str

Creates a string slice from this OrderBy.

Trait Implementations

impl AsRef<str> for OrderBy

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for OrderBy

fn clone(&self) -> OrderBy

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for OrderBy

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for OrderBy

fn deserialize<D>( deserializer: D, ) -> Result<OrderBy, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for OrderBy

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

Formats the value using the given formatter.

impl<T> From<T> for OrderBy

where T: AsRef<str> + Into<Box<str>>,

fn from(s: T) -> OrderBy

Converts to this type from the input type.

impl PartialEq for OrderBy

fn eq(&self, other: &OrderBy) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for OrderBy

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for OrderBy

impl StructuralPartialEq for OrderBy