Struct Config 

pub struct Config { /* private fields */ }

Settings for Database::open.

Implementations

impl Config

pub fn new(path: impl Into<PathBuf>, app_id: &str) -> Self

A local database file at path for the application app_id (reverse domain name).

pub fn p2p(self, config: P2pConfig) -> Self

Opens direct channels to other online devices while background sync runs, so they see each other’s writes within about a second. Off by default. See crate::p2p.

pub fn encrypt(self, password: &str) -> Self

Creates the database encrypted with this password (init), and unlocks with it.

pub fn password(self, password: &str) -> Self

Unlocks an encrypted database with this password (on open and join).

pub fn key(self, key: DataKey) -> Self

Unlocks an encrypted database with a data key cached by the app.

pub fn kdf_cost(self, m_kib: u32, t: u32, p: u32) -> Self

Argon2id cost for key files this device writes (memory in KiB, passes, lanes). The default is crate::crypto::DEFAULT_KDF_COST (64 MiB, 2, 1); tests may lower it.

pub fn snapshot_policy(self, policy: SnapshotPolicy) -> Self

Snapshot and compaction policy.

pub fn clock(self, clock: Arc<dyn Clock>) -> Self

Replaces the wall clock (tests and simulations).

pub fn pack_limits(self, limits: PackLimits) -> Self

Segment size limits.

pub fn device_name(self, name: &str) -> Self

Human-readable device name written to device.json.

pub fn conflict_log(self, limit: Option<u32>) -> Self

How many conflict records to keep (default 1,000); None turns the conflict log off.

Trait Implementations

impl Clone for Config

fn clone(&self) -> Self

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

Formats the value using the given formatter.