Struct Config 

pub struct Config {
    pub store_id: String,
    pub device_id: String,
    pub store_dir: StoreDir,
    pub store_name: String,
    pub encryption_key_stored: bool,
    pub encryption_key_fingerprint: Option<String>,
    pub cloud_home: CloudHomeConfig,
}

Sync + storage configuration for one store.

Fields

store_id: String

device_id: String

Unique device identifier for sync changeset namespacing.

store_dir: StoreDir

store_name: String

encryption_key_stored: bool

Whether an encryption key is stored in the keyring (hint flag).

encryption_key_fingerprint: Option<String>

SHA-256 fingerprint of the encryption key (detects wrong key without decryption).

cloud_home: CloudHomeConfig

Cloud home provider + its settings.

Implementations

impl Config

pub fn with_defaults( store_id: String, device_id: String, store_dir: StoreDir, store_name: String, ) -> Config

Construct a config with defaults for a new or joined store.

pub fn save_to_config_yaml(&self) -> Result<(), ConfigError>

Persist the sync config to store_dir/config.yaml.

pub fn load_from_config_yaml(store_dir: StoreDir) -> Result<Config, ConfigError>

Read store_dir/config.yaml back into a runtime Config; store_dir is supplied by the caller, since it is not itself persisted (see the module doc). A missing or unparseable file is a loud ConfigError naming the path.

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl From<Config> for CovenConfig

fn from(value: Config) -> Self

Converts to this type from the input type.

impl PartialEq for Config

fn eq(&self, other: &Config) -> 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 StructuralPartialEq for Config