Struct KeyringStore 

pub struct KeyringStore { /* private fields */ }

OS-backed credential storage scoped to one service identifier (bundle id / custom).

Implementations

impl KeyringStore

pub fn new(service: impl Into<String>) -> Self

Creates a store handle; no I/O until the first read/write (backend registers lazily).

pub fn service(&self) -> &str

Keyring service / namespace string passed to the native backend.

pub fn availability(&self) -> KeyringAvailability

Probes whether the OS keyring is readable without surfacing an error to callers.

On iOS, performs a read of a dedicated probe account: missing entry means available; keyring_core::Error::NoStorageAccess means locked. Other platforms always return KeyringAvailability::Available.

pub fn set_password(&self, account: &str, password: &str) -> Result<()>

Persists a UTF-8 secret (use Self::set_bytes for arbitrary bytes).

pub fn set_bytes(&self, account: &str, value: &[u8]) -> Result<()>

Encodes value as Base64 and stores it via Self::set_password.

pub fn get_password(&self, account: &str) -> Result<Option<String>>

Returns stored UTF-8, or None if the entry is missing.

pub fn get_password_for_background( &self, account: &str, ) -> Result<Option<String>>

Like Self::get_password, but returns [Ok(None)] when Self::availability is KeyringAvailability::Locked (intended for background sync without treating lock as a hard error).

pub fn get_bytes(&self, account: &str) -> Result<Option<Vec<u8>>>

Decodes Base64 from Self::get_password; returns None if missing.

pub fn get_bytes_for_background(&self, account: &str) -> Result<Option<Vec<u8>>>

Like Self::get_bytes, but returns [Ok(None)] when the keychain is locked (Self::get_password_for_background).

pub fn delete(&self, account: &str) -> Result<()>

Deletes the credential if present; missing entries are treated as success.

pub fn exists_nonempty(&self, account: &str) -> Result<bool>

true if a non-empty password exists for account.

pub fn exists_nonempty_for_background(&self, account: &str) -> Result<bool>

Like Self::exists_nonempty, but returns false when the keychain is locked.

pub fn account_raw( &self, snapshot_path: &str, client: &BytesDto, suffix: &str, ) -> String

Stable account id for an unstructured secret key under a snapshot + client namespace.

Example

use tauri_plugin_keyring_store::{BytesDto, KeyringStore};

let store = KeyringStore::new("com.example.app");
let client = BytesDto::Text("cli".into());
let account = store.account_raw("/data/main", &client, "token");
assert!(account.starts_with("kp:v1:"));

pub fn account_store_key( &self, snapshot_path: &str, client: &BytesDto, store_key: &str, ) -> String

Account key for a JSON store record (store_key is a logical filename).

pub fn account_vault_record( &self, snapshot_path: &str, client: &BytesDto, vault: &BytesDto, record_path: &BytesDto, ) -> String

Account key for binary vault payload at vault / record_path.

Trait Implementations

impl Clone for KeyringStore

fn clone(&self) -> KeyringStore

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for KeyringStore

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

Formats the value using the given formatter.