Enum SlidingSyncMode

pub enum SlidingSyncMode {
    Selective {
        ranges: Ranges,
    },
    Paging {
        batch_size: u32,
        maximum_number_of_rooms_to_fetch: Option<u32>,
    },
    Growing {
        batch_size: u32,
        maximum_number_of_rooms_to_fetch: Option<u32>,
    },
}

How a SlidingSyncList fetches the data.

Variants

Selective

Only sync the specific defined windows/ranges.

Fields

ranges: Ranges

The specific defined ranges.

Paging

Fully sync all rooms in the background, page by page of batch_size, like 0..=19, 20..=39, 40..=59 etc. assuming the batch_size is 20.

Fields

batch_size: u32

The batch size.

maximum_number_of_rooms_to_fetch: Option<u32>

The maximum number of rooms to fetch. None to fetch everything possible.

Growing

Fully sync all rooms in the background, with a growing window of batch_size, like 0..=19, 0..=39, 0..=59 etc. assuming the batch_size is 20.

Fields

batch_size: u32

The batch size.

maximum_number_of_rooms_to_fetch: Option<u32>

The maximum number of rooms to fetch. None to fetch everything possible.

Implementations

impl SlidingSyncMode

pub fn new_selective() -> SlidingSyncSelectiveModeBuilder

Create a SlidingSyncMode::Selective.

pub fn new_paging(batch_size: u32) -> SlidingSyncWindowedModeBuilder

Create a SlidingSyncMode::Paging.

pub fn new_growing(batch_size: u32) -> SlidingSyncWindowedModeBuilder

Create a SlidingSyncMode::Growing.

Trait Implementations

impl Clone for SlidingSyncMode

fn clone(&self) -> SlidingSyncMode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SlidingSyncMode

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

Formats the value using the given formatter.

impl Default for SlidingSyncMode

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SlidingSyncMode

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<SlidingSyncSelectiveModeBuilder> for SlidingSyncMode

fn from(builder: SlidingSyncSelectiveModeBuilder) -> Self

Converts to this type from the input type.

impl From<SlidingSyncWindowedModeBuilder> for SlidingSyncMode

fn from(builder: SlidingSyncWindowedModeBuilder) -> Self

Converts to this type from the input type.

impl PartialEq for SlidingSyncMode

fn eq(&self, other: &SlidingSyncMode) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for SlidingSyncMode

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for SlidingSyncMode

impl StructuralPartialEq for SlidingSyncMode