Struct Status

pub struct Status {
    pub offline: bool,
    pub syncing: bool,
    pub out_of_space: bool,
    pub pending_shares: bool,
    pub update_required: bool,
    pub pushing_files: Vec<Uuid>,
    pub dirty_locally: Vec<Uuid>,
    pub pulling_files: Vec<Uuid>,
    pub space_used: Option<UsageMetrics>,
    pub sync_status: Option<String>,
    pub unexpected_sync_problem: Option<String>,
}

lb-rs may be used by multiple disconnected components which may not be able to seamlessly share state among one another. this struct provides a snapshot into what overall state of data and tasks are within lb-rs.

the fields are roughly in order of priority, if your UI has limited space to represent information (phones?) earlier fields are more important than later fields. Ideally anything with an ID is represented in the file tree itself.

Fields

offline: bool

some recent server interaction failed due to network conditions

syncing: bool

a sync is in progress

out_of_space: bool

at-least one document cannot be pushed due to a data cap

pending_shares: bool

there are pending shares

update_required: bool

you must update to be able to sync, see update_available below

pushing_files: Vec<Uuid>

metadata or content for this id is being sent to the server

dirty_locally: Vec<Uuid>

following files need to be pushed

pulling_files: Vec<Uuid>

metadata or content for this id is being from the server callers should be prepared to handle ids they don’t know about yet.

space_used: Option<UsageMetrics>

a mix of human readable and precise data for used, and available space

sync_status: Option<String>

if there is no pending work this will have a human readable description of when we last synced successfully

unexpected_sync_problem: Option<String>

Implementations

impl Status

pub fn msg(&self) -> Option<String>

Trait Implementations

impl Clone for Status

fn clone(&self) -> Status

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Status

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

Formats the value using the given formatter.

impl Default for Status

fn default() -> Status

Returns the “default value” for a type.