Enum ResultGroupMap 

#[non_exhaustive]
pub enum ResultGroupMap {
    RoomId(BTreeMap<OwnedRoomId, ResultGroup>),
    Sender(BTreeMap<OwnedUserId, ResultGroup>),
}

Available on crate features client or server only.

A map of results grouped by key.

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(BTreeMap<OwnedRoomId, ResultGroup>)

Results grouped by room ID.

Sender(BTreeMap<OwnedUserId, ResultGroup>)

Results grouped by sender.

Implementations

impl ResultGroupMap

pub fn grouping_key(&self) -> GroupingKey

The key that was used to group this map.

pub fn custom_map(&self) -> Option<&BTreeMap<String, ResultGroup>>

The map of grouped results, if this uses a custom key.

pub fn into_custom_map(self) -> Option<BTreeMap<String, ResultGroup>>

Convert this into the map of grouped results, if this uses a custom key.

Trait Implementations

impl Clone for ResultGroupMap

fn clone(&self) -> ResultGroupMap

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ResultGroupMap

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

Formats the value using the given formatter.

impl Extend<ResultGroupMap> for ResultGroupMapsByGroupingKey

fn extend<T: IntoIterator<Item = ResultGroupMap>>(&mut self, iter: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl FromIterator<ResultGroupMap> for ResultGroupMapsByGroupingKey

fn from_iter<T: IntoIterator<Item = ResultGroupMap>>(iter: T) -> Self

Creates a value from an iterator.