Struct Relations

pub struct Relations {
    pub chunk: Vec<TimelineEvent>,
    pub prev_batch_token: Option<String>,
    pub next_batch_token: Option<String>,
    pub recursion_depth: Option<UInt>,
}

The result of a super::Room::relations query.

This is a wrapper around the Ruma equivalents, with events decrypted if needs be.

Fields

chunk: Vec<TimelineEvent>

The events related to the specified event from the request.

Note: the events will be sorted according to the dir parameter:

• if the direction was backwards, then the events will be ordered in reverse topological order.
• if the direction was forwards, then the events will be ordered in topological order.

prev_batch_token: Option<String>

An opaque string representing a pagination token to retrieve the previous batch of events.

next_batch_token: Option<String>

An opaque string representing a pagination token to retrieve the next batch of events.

recursion_depth: Option<UInt>

If RelationsOptions::recurse was set, the depth to which the server recursed.

Trait Implementations

impl Debug for Relations

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

Formats the value using the given formatter.