Struct LockedKeyring 

pub struct LockedKeyring { /* private fields */ }

A locked keyring that requires a secret to unlock.

Implementations

impl LockedKeyring

pub async fn validate_secret(&self, secret: &Secret) -> Result<bool, Error>

Validate that a secret can decrypt the items in this keyring.

For empty keyrings, this always returns true since there are no items to validate against.

Arguments

• secret - The secret to validate.

pub async fn validate_unencrypted(&self) -> Result<bool, Error>

pub fn path(&self) -> Option<&Path>

Return the associated file if any.

pub async fn modified_time(&self) -> Duration

Get the modification timestamp

pub async fn items(&self) -> Result<Vec<LockedItem>, Error>

Retrieve the list of available LockedItems without decrypting them.

pub async fn unlock(self, secret: Secret) -> Result<UnlockedKeyring, Error>

Unlocks a keyring and validates it

pub async unsafe fn unlock_unchecked( self, secret: Secret, ) -> Result<UnlockedKeyring, Error>

Unlocks a keyring without validating it

Safety

This method skips validation and doesn’t verify that the secret can decrypt all items in the keyring. Use only for recovery scenarios where you need to access a partially corrupted keyring. The keyring may contain items that cannot be decrypted with the provided secret.

pub async fn unlock_unencrypted(self) -> Result<UnlockedKeyring, Error>

Unlocks a keyring without a secret, for unencrypted keyrings.

Validates that existing items (if any) can be read without encryption. Returns Error::IncorrectSecret if encrypted items are found.

pub async fn load(path: impl AsRef<Path>) -> Result<Self, Error>

Load a keyring from a file path.

pub async fn open(name: &str) -> Result<Self, Error>

Open a named keyring.

pub async fn open_at( data_dir: impl AsRef<Path>, name: &str, ) -> Result<Self, Error>

Open a locked keyring at a specific data directory.

This is useful for tests and cases where you want explicit control over where keyrings are stored, avoiding the default XDG_DATA_HOME location.

Arguments

• data_dir - Base data directory (keyrings stored in data_dir/keyrings/v1/)
• name - The name of the keyring.

Trait Implementations

impl Debug for LockedKeyring

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

Formats the value using the given formatter.

impl From<LockedKeyring> for Keyring

fn from(keyring: LockedKeyring) -> Self

Converts to this type from the input type.