Enum SyncMode 

pub enum SyncMode {
    Full,
    Metadata,
    Off,
}

Per-document sync policy. The wire/config token is the lowercase variant name (full | metadata | off).

Variants

Full

Metadata record + document bytes (blob) + reading state. The default, and the historical all-in behavior.

Metadata

Metadata record + reading state (progress, bookmarks, highlights, notes), but never the document bytes — the file stays on the device.

Off

Nothing about this document leaves (or reaches) the device.

Implementations

impl SyncMode

pub fn most_restrictive(self, other: SyncMode) -> SyncMode

The more restrictive of two modes — the effective mode when a server ceiling and a client clamp both apply. Combining is a min on rank, so a client can lower its mode but never raise it above the server’s.

pub fn syncs_blob(self) -> bool

Whether the document’s bytes (blob) may sync in this mode.

pub fn syncs_state(self) -> bool

Whether reading state (progress + annotations) and the metadata record may sync in this mode.

pub fn syncs_anything(self) -> bool

Whether anything at all syncs. False only for SyncMode::Off.

pub fn as_str(self) -> &'static str

The wire / config token: full | metadata | off.

pub fn from_token_or_default(s: &str) -> SyncMode

Parse a stored/wire token, falling back to SyncMode::Full for anything unrecognized (an older row, a hand-edited value) so a bad token never silently disables sync.

Trait Implementations

impl Clone for SyncMode

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for SyncMode

impl Debug for SyncMode

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

Formats the value using the given formatter.

impl Default for SyncMode

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SyncMode

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for SyncMode

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

Formats the value using the given formatter.

impl Eq for SyncMode

impl FromStr for SyncMode

type Err = ()

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for SyncMode

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for SyncMode

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for SyncMode

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for SyncMode