Struct seshat::LoadConfig
source · pub struct LoadConfig { /* private fields */ }
Expand description
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§
source§impl LoadConfig
impl LoadConfig
sourcepub fn new<R: Into<String>>(room_id: R) -> Self
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.
sourcepub fn limit(self, limit: usize) -> Self
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.
sourcepub fn from_event<E: Into<String>>(self, event_id: E) -> Self
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.
sourcepub fn direction(self, direction: LoadDirection) -> Self
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§
source§impl Clone for LoadConfig
impl Clone for LoadConfig
source§fn clone(&self) -> LoadConfig
fn clone(&self) -> LoadConfig
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moresource§impl Debug for LoadConfig
impl Debug for LoadConfig
source§impl<'de> Deserialize<'de> for LoadConfig
impl<'de> Deserialize<'de> for LoadConfig
source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
Auto Trait Implementations§
impl Freeze for LoadConfig
impl RefUnwindSafe for LoadConfig
impl Send for LoadConfig
impl Sync for LoadConfig
impl Unpin for LoadConfig
impl UnwindSafe for LoadConfig
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Convert
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
.source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Convert
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
Convert
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
Convert
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.source§impl<T> DowncastSync for T
impl<T> DowncastSync for T
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more