Struct ResultGroup

#[non_exhaustive]
pub struct ResultGroup {
    pub next_batch: Option<String>,
    pub order: Option<UInt>,
    pub results: Vec<OwnedEventId>,
}

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

A grouping of results, if requested.

Fields (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.

next_batch: Option<String>

Token that can be used to get the next batch of results in the group, by passing as the next_batch parameter to the next call.

If this field is absent, there are no more results in this group.

order: Option<UInt>

Key that can be used to order different groups.

results: Vec<OwnedEventId>

Which results are in this group.

Implementations

impl ResultGroup

pub fn new() -> ResultGroup

Creates an empty ResultGroup.

pub fn is_empty(&self) -> bool

Returns true if all fields are empty / None.

Trait Implementations

impl Clone for ResultGroup

fn clone(&self) -> ResultGroup

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ResultGroup

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

Formats the value using the given formatter.

impl Default for ResultGroup

fn default() -> ResultGroup

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ResultGroup

fn deserialize<__D>( __deserializer: __D, ) -> Result<ResultGroup, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ResultGroup

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.