Struct Store 

pub struct Store {
    pub id: String,
    pub creds: CredMap,
    pub backing: Option<String>,
    pub self_ref: RwLock<SelfRef>,
}

A credential store.

The credential data is kept in the CredMap. We keep the index of ourself in the STORES vector, so we can get a pointer to ourself whenever we need to build a credential.

Fields

id: String

creds: CredMap

backing: Option<String>

self_ref: RwLock<SelfRef>

Implementations

impl Store

pub fn new() -> Result<Arc<Self>>

Create a new store with a default configuration.

The default configuration is empty with no backing file.

pub fn new_with_configuration(config: &HashMap<&str, &str>) -> Result<Arc<Self>>

Create a new store with a user-specified configuration.

The only allowed configuration option is the path to the backing file, which should be the value of the backing_file key in the config map. See new_with_backing for details.

pub fn new_with_backing(path: &str) -> Result<Arc<Self>>

Create a new store from a backing file.

The backing file must be a valid path, but it need not exist, in which case the store starts off empty. If the file does exist, the initial contents of the store are loaded from it.

pub fn save(&self) -> Result<()>

Save this store to its backing file.

This is a no-op if there is no backing file.

Stores will save themselves to their backing file when they go out of scope (i.e., are dropped), but this call can be very useful if you specify an instance of your store as the keyring-core API default store, because the default store is kept in a static variable and thus is never dropped.

pub fn new_internal(creds: CredMap, backing: Option<String>) -> Arc<Self>

Create a store with the given credentials and backing file.

pub fn load_credentials(path: &str) -> Result<CredMap>

Loads store content from a backing file.

If the backing file does not exist, the returned store is empty.

Trait Implementations

impl CredentialStoreApi for Store

fn vendor(&self) -> String

See the API docs.

fn id(&self) -> String

See the API docs.

The store ID is based on its sequence number in the list of created stores.

fn build( &self, service: &str, user: &str, mods: Option<&HashMap<&str, &str>>, ) -> Result<Entry>

See the API docs.

The only modifier you can specify is force-create, which forces immediate credential creation and can be used to create ambiguity.

When the force-create modifier is specified, the created credential gets an empty password/secret, a comment attribute with the value of the modifier, and a creation_date` attribute with a string for the current local time.

fn search(&self, spec: &HashMap<&str, &str>) -> Result<Vec<Entry>>

See the API docs.

The specification must contain exactly two keys - service and user - and their values must be valid regular expressions. Every credential whose service name matches the service regex and whose username matches the user regex will be returned. (The match is a substring match, so the empty string will match every value.)

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

See the API docs.

fn as_any(&self) -> &dyn Any

Return the inner store object cast to Any.

fn persistence(&self) -> CredentialPersistence

The lifetime of credentials produced by this builder.

impl Debug for Store

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

Formats the value using the given formatter.

impl Drop for Store

fn drop(&mut self)

Executes the destructor for this type.