Struct matrix_sdk_base::ruma::events::poll::end::PollResultsContentBlock

#[non_exhaustive]
pub struct PollResultsContentBlock(/* private fields */);

Available on crate feature unstable-msc3381 only.

Expand description

A block for the results of a poll.

This is a map of answer ID to number of votes.

Implementations§

§

impl PollResultsContentBlock

pub fn sorted(&self) -> Vec<(&str, UInt)>

Get these results sorted from the highest number of votes to the lowest.

Returns a list of (answer ID, number of votes).

Methods from Deref<Target = BTreeMap<String, UInt>>§

1.0.0 · source

pub fn get<Q>(&self, key: &Q) -> Option<&V>
where K: Borrow<Q> + Ord, Q: Ord + ?Sized,

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

Returns a reference to the value corresponding to the key.

The key may be any borrowed form of the map’s key type, but the ordering on the borrowed form must match the ordering on the key type.

pub fn get_key_value<Q>(&self, k: &Q) -> Option<(&K, &V)>
where K: Borrow<Q> + Ord, Q: Ord + ?Sized,

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

Returns the key-value pair corresponding to the supplied key.

The supplied key may be any borrowed form of the map’s key type, but the ordering on the borrowed form must match the ordering on the key type.

pub fn first_key_value(&self) -> Option<(&K, &V)>
where K: Ord,

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

Returns the first key-value pair in the map. The key in this pair is the minimum key in the map.

pub fn last_key_value(&self) -> Option<(&K, &V)>
where K: Ord,

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

Returns the last key-value pair in the map. The key in this pair is the maximum key in the map.

pub fn contains_key<Q>(&self, key: &Q) -> bool
where K: Borrow<Q> + Ord, Q: Ord + ?Sized,

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

Returns true if the map contains a value for the specified key.

The key may be any borrowed form of the map’s key type, but the ordering on the borrowed form must match the ordering on the key type.

pub fn range<T, R>(&self, range: R) -> Range<'_, K, V>
where T: Ord + ?Sized, K: Borrow<T> + Ord, R: RangeBounds<T>,

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

Constructs a double-ended iterator over a sub-range of elements in the map. The simplest way is to use the range syntax min..max, thus range(min..max) will yield elements from min (inclusive) to max (exclusive). The range may also be entered as (Bound<T>, Bound<T>), so for example range((Excluded(4), Included(10))) will yield a left-exclusive, right-inclusive range from 4 to 10.

Panics

Panics if range start > end. Panics if range start == end and both bounds are Excluded.

Examples

use std::collections::BTreeMap;
use std::ops::Bound::Included;

let mut map = BTreeMap::new();
map.insert(3, "a");
map.insert(5, "b");
map.insert(8, "c");
for (&key, &value) in map.range((Included(&4), Included(&8))) {
    println!("{key}: {value}");
}
assert_eq!(Some((&5, &"b")), map.range(4..).next());

1.0.0 · source

pub fn iter(&self) -> Iter<'_, K, V>

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

Gets an iterator over the entries of the map, sorted by key.

Examples

use std::collections::BTreeMap;

let mut map = BTreeMap::new();
map.insert(3, "c");
map.insert(2, "b");
map.insert(1, "a");

for (key, value) in map.iter() {
    println!("{key}: {value}");
}

let (first_key, first_value) = map.iter().next().unwrap();
assert_eq!((*first_key, *first_value), (1, "a"));

1.0.0 · source

pub fn keys(&self) -> Keys<'_, K, V>

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

Gets an iterator over the keys of the map, in sorted order.

Examples

use std::collections::BTreeMap;

let mut a = BTreeMap::new();
a.insert(2, "b");
a.insert(1, "a");

let keys: Vec<_> = a.keys().cloned().collect();
assert_eq!(keys, [1, 2]);

1.0.0 · source

pub fn values(&self) -> Values<'_, K, V>

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

Gets an iterator over the values of the map, in order by key.

Examples

use std::collections::BTreeMap;

let mut a = BTreeMap::new();
a.insert(1, "hello");
a.insert(2, "goodbye");

let values: Vec<&str> = a.values().cloned().collect();
assert_eq!(values, ["hello", "goodbye"]);

1.0.0 · source

pub fn len(&self) -> usize

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

Returns the number of elements in the map.

Examples

use std::collections::BTreeMap;

let mut a = BTreeMap::new();
assert_eq!(a.len(), 0);
a.insert(1, "a");
assert_eq!(a.len(), 1);

1.0.0 · source

pub fn is_empty(&self) -> bool

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

Returns true if the map contains no elements.

Examples

use std::collections::BTreeMap;

let mut a = BTreeMap::new();
assert!(a.is_empty());
a.insert(1, "a");
assert!(!a.is_empty());

source

pub fn lower_bound<Q>(&self, bound: Bound<&Q>) -> Cursor<'_, K, V>
where K: Borrow<Q> + Ord, Q: Ord,

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

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

Returns a Cursor pointing at the first element that is above the given bound.

If no such element exists then a cursor pointing at the “ghost” non-element is returned.

Passing Bound::Unbounded will return a cursor pointing at the first element of the map.

Examples

#![feature(btree_cursors)]

use std::collections::BTreeMap;
use std::ops::Bound;

let mut a = BTreeMap::new();
a.insert(1, "a");
a.insert(2, "b");
a.insert(3, "c");
a.insert(4, "c");
let cursor = a.lower_bound(Bound::Included(&2));
assert_eq!(cursor.key(), Some(&2));
let cursor = a.lower_bound(Bound::Excluded(&2));
assert_eq!(cursor.key(), Some(&3));

source

pub fn upper_bound<Q>(&self, bound: Bound<&Q>) -> Cursor<'_, K, V>
where K: Borrow<Q> + Ord, Q: Ord,

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

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

Returns a Cursor pointing at the last element that is below the given bound.

If no such element exists then a cursor pointing at the “ghost” non-element is returned.

Passing Bound::Unbounded will return a cursor pointing at the last element of the map.

Examples

#![feature(btree_cursors)]

use std::collections::BTreeMap;
use std::ops::Bound;

let mut a = BTreeMap::new();
a.insert(1, "a");
a.insert(2, "b");
a.insert(3, "c");
a.insert(4, "c");
let cursor = a.upper_bound(Bound::Included(&3));
assert_eq!(cursor.key(), Some(&3));
let cursor = a.upper_bound(Bound::Excluded(&3));
assert_eq!(cursor.key(), Some(&2));