Struct matrix_sdk::config::SyncSettings
source · pub struct SyncSettings { /* private fields */ }
Expand description
Settings for a sync call.
Implementations§
source§impl SyncSettings
impl SyncSettings
sourcepub fn timeout(self, timeout: Duration) -> Self
pub fn timeout(self, timeout: Duration) -> Self
Set the maximum time the server can wait, in milliseconds, before responding to the sync request.
§Arguments
timeout
- The time the server is allowed to wait.
sourcepub fn filter(self, filter: Filter) -> Self
pub fn filter(self, filter: Filter) -> Self
Set the sync filter. It can be either the filter ID, or the definition for the filter.
§Arguments
filter
- The filter configuration that should be used for the sync call.
sourcepub fn full_state(self, full_state: bool) -> Self
pub fn full_state(self, full_state: bool) -> Self
Should the server return the full state from the start of the timeline.
This does nothing if no sync token is set.
§Arguments
full_state
- A boolean deciding if the server should return the full state or not.
sourcepub fn set_presence(self, presence: PresenceState) -> Self
pub fn set_presence(self, presence: PresenceState) -> Self
Set the presence state
PresenceState::Online
- The client is marked as being online. This is
the default preset.
PresenceState::Offline
- The client is not marked as being online.
PresenceState::Unavailable
- The client is marked as being idle.
§Arguments
set_presence
- ThePresenceState
that the server should set for the client.
Trait Implementations§
source§impl Clone for SyncSettings
impl Clone for SyncSettings
source§fn clone(&self) -> SyncSettings
fn clone(&self) -> SyncSettings
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 SyncSettings
Available on non-tarpaulin_include
only.
impl Debug for SyncSettings
Available on non-
tarpaulin_include
only.Auto Trait Implementations§
impl RefUnwindSafe for SyncSettings
impl Send for SyncSettings
impl Sync for SyncSettings
impl Unpin for SyncSettings
impl UnwindSafe for SyncSettings
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
§impl<T> CompatExt for T
impl<T> CompatExt for T
§impl<T> FutureExt for T
impl<T> FutureExt for T
§fn with_context(self, otel_cx: Context) -> WithContext<Self>
fn with_context(self, otel_cx: Context) -> WithContext<Self>
§fn with_current_context(self) -> WithContext<Self>
fn with_current_context(self) -> WithContext<Self>
§impl<T, UT> HandleAlloc<UT> for T
impl<T, UT> HandleAlloc<UT> for T
§fn new_handle(value: Arc<T>) -> Handle
fn new_handle(value: Arc<T>) -> Handle
Create a new handle for an Arc value Read more
§fn clone_handle(handle: Handle) -> Handle
fn clone_handle(handle: Handle) -> Handle
Clone a handle Read more
§fn consume_handle(handle: Handle) -> Arc<T>
fn consume_handle(handle: Handle) -> Arc<T>
Consume a handle, getting back the initial
Arc<>
§impl<T> Identity for Twhere
T: ?Sized,
impl<T> Identity for Twhere
T: ?Sized,
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
§impl<T> IntoResult<T> for T
impl<T> IntoResult<T> for T
type Err = Infallible
fn into_result(self) -> Result<T, <T as IntoResult<T>>::Err>
§impl<T> Pointable for T
impl<T> Pointable for T
source§impl<R, P> ReadPrimitive<R> for P
impl<R, P> ReadPrimitive<R> for P
source§fn read_from_little_endian(read: &mut R) -> Result<Self, Error>
fn read_from_little_endian(read: &mut R) -> Result<Self, Error>
Read this value from the supplied reader. Same as
ReadEndian::read_from_little_endian()
.