Struct DefaultKeyringStore 

pub struct DefaultKeyringStore { /* private fields */ }

OS-native keyring backend.

Wraps the platform credential store:

• macOS: Keychain (via security framework)
• Windows: Credential Manager
• Linux: Secret Service (GNOME Keyring / kwallet via dbus), excluding OHOS

This backend is opt-in – set the SECRET_BACKEND_ENV environment variable to system or keyring to activate it. On platforms without a configured native keyring dependency, probe returns an unsupported error so Secrets::auto_detect can transparently fall back to FileKeyringStore.

Implementations

impl DefaultKeyringStore

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

Build a new store with the given service name.

pub fn probe(&self) -> Result<(), SecretsError>

Probe the OS keyring without writing anything. Returns Ok(()) if a backend is reachable, otherwise an error describing why not.

The probe reads a deliberately-nonexistent entry: reaching the backend and learning the entry is absent is the reachability signal. This does not prompt on any supported platform — macOS only surfaces Keychain UI when accessing an existing item owned by another application, and Windows Credential Manager never prompts for a missing target — so __probe__ under our own service name is safe to read. Entry::new alone validates only argument shapes, which left this probe a no-op on macOS/Windows and the documented file-store fallback unreachable there (#5172).

Trait Implementations

impl Clone for DefaultKeyringStore

fn clone(&self) -> DefaultKeyringStore

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DefaultKeyringStore

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

Formats the value using the given formatter.

impl Default for DefaultKeyringStore

fn default() -> Self

Returns the “default value” for a type.

impl KeyringStore for DefaultKeyringStore

fn get(&self, key: &str) -> Result<Option<String>, SecretsError>

Read a secret by key.

fn set(&self, key: &str, value: &str) -> Result<(), SecretsError>

Write a secret, replacing any existing value for the same key.

fn delete(&self, key: &str) -> Result<(), SecretsError>

Remove a secret by key.

fn backend_name(&self) -> &'static str

Short, human-readable label for this backend.