Struct SettingsStore 

pub struct SettingsStore { /* private fields */ }

A settings-specific Store that wraps DocStore and provides specialized methods for managing database settings and authentication configuration.

SettingsStore provides a clean abstraction over the _settings subtree, offering type-safe methods for common settings operations while delegating to AuthSettings for authentication-specific functionality.

Implementations

impl SettingsStore

pub async fn get_name(&self) -> Result<String>

Get the database name from settings

Returns

The database name as a string, or an error if not found or invalid

pub async fn set_name(&self, name: &str) -> Result<()>

Set the database name in settings

Arguments

• name - The name to set for the database

Returns

Result indicating success or failure

pub async fn get(&self, key: impl AsRef<str>) -> Result<Value>

Get a value from settings by key

Arguments

• key - The key to retrieve

Returns

The value associated with the key, or an error if not found

pub async fn get_string(&self, key: impl AsRef<str>) -> Result<String>

Get a string value from settings by key

Arguments

• key - The key to retrieve

Returns

The string value associated with the key, or an error if not found or wrong type

pub async fn get_all(&self) -> Result<Doc>

Get all settings as a Doc

Returns a complete snapshot of all settings in the _settings subtree.

Returns

A Doc containing all current settings

pub async fn get_height_strategy(&self) -> Result<HeightStrategy>

Get the height strategy for this database.

Returns HeightStrategy::Incremental if no strategy is configured, ensuring backwards compatibility with existing databases.

Returns

The configured height strategy, or the default (Incremental)

pub async fn set_height_strategy(&self, strategy: HeightStrategy) -> Result<()>

Set the height strategy for this database.

Arguments

• strategy - The height strategy to use

pub async fn auth_snapshot(&self) -> Result<AuthSettings>

Get a snapshot of the current authentication settings

Returns a cloned AuthSettings built from the merged CRDT state. Mutations to the returned value do not propagate back to the store; use the dedicated methods (e.g. set_auth_key, rename_auth_key, revoke_auth_key) to persist changes.

Returns

An AuthSettings snapshot of the current auth configuration

pub async fn set_auth_key(&self, pubkey: &PublicKey, key: AuthKey) -> Result<()>

Set an authentication key in the settings

This method provides upsert behavior for authentication keys:

• If the pubkey doesn’t exist: creates the key entry
• If the pubkey exists: updates the key with new permissions/status/name

Keys are stored by pubkey (the cryptographic public key string). The AuthKey contains optional name metadata and permission information.

Writes are incremental: only the specific key path is written to the entry, not the full auth state. The CRDT merge produces the correct merged view when reading.

Arguments

• pubkey - The public key
• key - The AuthKey containing name, permissions, and status

Returns

Result indicating success or failure

pub async fn set_global_auth_key(&self, key: AuthKey) -> Result<()>

Set the global authentication permission

Stores the global permission at the auth.global path, separate from individual key entries in the auth.keys namespace.

Arguments

• key - The AuthKey containing the global permission level and status

Returns

Result indicating success or failure

pub async fn get_global_auth_key(&self) -> Result<AuthKey>

Get the global authentication permission

Reads from the auth.global path via an auth snapshot.

Returns

AuthKey if the global permission is configured, or error if not present

pub async fn get_auth_key(&self, pubkey: &PublicKey) -> Result<AuthKey>

Get an authentication key from the settings by public key

Arguments

• pubkey - The public key to retrieve

Returns

AuthKey if found, or error if not present or operation fails

pub async fn rename_auth_key( &self, pubkey: &PublicKey, name: Option<&str>, ) -> Result<()>

Rename an authentication key in the settings

Updates only the display name of an existing key, preserving its permissions and status.

Arguments

• pubkey - The public key of the key to rename
• name - The new display name, or None to remove the name

Returns

Result indicating success or failure

pub async fn revoke_auth_key(&self, pubkey: &PublicKey) -> Result<()>

Revoke an authentication key in the settings

Arguments

• pubkey - The public key of the key to revoke

Returns

Result indicating success or failure

pub async fn add_delegated_tree(&self, tree_ref: DelegatedTreeRef) -> Result<()>

Add a delegated tree reference to the settings

The delegation is stored by root tree ID, extracted from tree_ref.tree.root.

Arguments

• tree_ref - The delegated tree reference to add

Returns

Result indicating success or failure

pub async fn get_auth_doc_for_validation(&self) -> Result<Doc>

Get the auth document for validation purposes

This returns the raw Doc containing auth configuration, suitable for use with AuthValidator and other validation components that expect the raw CRDT state.

Returns

A Doc containing the auth configuration

pub fn as_doc_store(&self) -> &DocStore

Get access to the underlying DocStore for advanced operations

This provides direct access to the DocStore for cases where the SettingsStore abstraction is insufficient.

Returns

A reference to the underlying DocStore