Enum ruma_client_api::search::search_events::v3::GroupingKey

#[non_exhaustive]
pub enum GroupingKey {
    RoomId,
    Sender,
    // some variants omitted
}

The key within events to use for this grouping.

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 formats 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.

RoomId

room_id

Sender

sender

Implementations

impl GroupingKey

pub fn as_str(&self) -> &str

Creates a string slice from this GroupingKey.

Trait Implementations

impl AsRef<str> for GroupingKey

fn as_ref(&self) -> &str

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

impl Clone for GroupingKey

fn clone(&self) -> GroupingKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GroupingKey

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for GroupingKey

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

Deserialize this value from the given Serde deserializer.

impl Display for GroupingKey

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

Formats the value using the given formatter.

impl<T> From<T> for GroupingKey where
    T: AsRef<str> + Into<Box<str>>, 

fn from(s: T) -> Self

Converts to this type from the input type.

impl Ord for GroupingKey

fn cmp(&self, other: &GroupingKey) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<GroupingKey> for GroupingKey

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

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

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

This method tests for !=.

impl PartialOrd<GroupingKey> for GroupingKey

fn partial_cmp(&self, other: &GroupingKey) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for GroupingKey

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

Serialize this value into the given Serde serializer.

impl Eq for GroupingKey

impl StructuralEq for GroupingKey

impl StructuralPartialEq for GroupingKey