Enum matrix_sdk_ui::room_list_service::SyncIndicator

pub enum SyncIndicator {
    Show,
    Hide,
}

An hint whether a sync spinner/loader/toaster should be prompted to the user, indicating that the RoomListService is syncing.

This is entirely arbitrary and optinionated. Of course, once RoomListService::sync has been called, it’s going to be constantly syncing, until RoomListService::stop_sync is called, or until an error happened. But in some cases, it’s better for the user experience to prompt to the user that a sync is happening. It’s usually the first sync, or the recovering sync. However, the sync indicator must be prompted if the aforementioned sync is “slow”, otherwise the indicator is likely to “blink” pretty fast, which can be very confusing. It’s also common to indicate to the user that a syncing is happening in case of a network error, that something is catching up etc.

Variants

Show

Show the sync indicator.

Hide

Hide the sync indicator.

Trait Implementations

impl Debug for SyncIndicator

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

Formats the value using the given formatter.

impl PartialEq for SyncIndicator

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for SyncIndicator

impl StructuralPartialEq for SyncIndicator