Struct seshat::LoadConfig

pub struct LoadConfig { /* fields omitted */ }

Configuration for the event loading methods.

A load configuration allows users to limit the number of events that will be loaded or to continue loading events from a specific point in the room history.

Implementations

impl LoadConfig

pub fn new<R: Into<String>>(room_id: R) -> Self

Create a new LoadConfig

The config will be created with a default limit of 20 events.

Arguments

• room_id - The room from which to load the events.

pub fn limit(self, limit: usize) -> Self

Set the maximum amount of events that we want to load.

Arguments

• limit - The new limit that should be set.

pub fn from_event<E: Into<String>>(self, event_id: E) -> Self

Set the event from which we should continue loading events.

Arguments

• event_id - An event id of a previous event returned by this method. If set events that are older than the event with the given event ID will be returned.

pub fn direction(self, direction: LoadDirection) -> Self

Set the direction that we are going to continue loading events from.

This is only used if we are continuing loading events, that is if from_event() is also set.

Arguments

• direction - The direction that should be used.

Trait Implementations

impl Clone for LoadConfig

fn clone(&self) -> LoadConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LoadConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for LoadConfig

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

Deserialize this value from the given Serde deserializer.

impl Serialize for LoadConfig

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

Serialize this value into the given Serde serializer.