Struct LoginStore 

pub struct LoginStore {
    pub db: Mutex<Option<LoginDb>>,
}

Fields

db: Mutex<Option<LoginDb>>

Implementations

impl LoginStore

pub fn new( path: impl AsRef<Path>, encdec: Arc<dyn EncryptorDecryptor>, ) -> ApiResult<Self>

pub fn new_from_db(db: LoginDb) -> Self

pub fn lock_db(&self) -> Result<MappedMutexGuard<'_, LoginDb>>

pub fn is_empty(&self) -> ApiResult<bool>

pub fn list(&self) -> ApiResult<Vec<Login>>

pub fn list_candidates(&self) -> ApiResult<Vec<LoginCandidate>>

List all logins without decrypting them.

Unlike list() this never touches the encryption key, so consumers which only need the cleartext fields to decide which logins they care about can filter without forcing the user to authenticate. Feed the ids of the matches to get_many().

pub fn count(&self) -> ApiResult<i64>

pub fn count_by_origin(&self, origin: &str) -> ApiResult<i64>

pub fn count_by_form_action_origin( &self, form_action_origin: &str, ) -> ApiResult<i64>

pub fn get(&self, id: &str) -> ApiResult<Option<Login>>

pub fn get_many(&self, ids: Vec<String>) -> ApiResult<Vec<Login>>

Get the logins with the given ids, decrypting them.

This is the other half of list_candidates(): having filtered on the cleartext fields, only pay for decrypting the logins which actually matched. Ids we don’t have a login for are skipped; a login we can’t decrypt fails the call, as it does for list().

pub fn get_by_base_domain(&self, base_domain: &str) -> ApiResult<Vec<Login>>

pub fn has_logins_by_base_domain(&self, base_domain: &str) -> ApiResult<bool>

pub fn find_login_to_update( &self, entry: LoginEntry, ) -> ApiResult<Option<Login>>

pub fn touch(&self, id: &str) -> ApiResult<()>

pub fn are_potentially_vulnerable_passwords( &self, ids: Vec<String>, ) -> ApiResult<Vec<String>>

pub fn is_potentially_vulnerable_password(&self, id: &str) -> ApiResult<bool>

pub fn record_potentially_vulnerable_passwords( &self, passwords: Vec<String>, ) -> ApiResult<()>

pub fn reset_all_breaches(&self) -> ApiResult<()>

pub fn record_breach_alert_dismissal(&self, id: &str) -> ApiResult<()>

pub fn record_breach_alert_dismissal_time( &self, id: &str, timestamp: i64, ) -> ApiResult<()>

pub fn delete(&self, id: &str) -> ApiResult<bool>

pub fn delete_many(&self, ids: Vec<String>) -> ApiResult<Vec<bool>>

pub fn delete_all(&self) -> ApiResult<Vec<String>>

pub fn delete_all_except_fxa(&self) -> ApiResult<Vec<String>>

pub fn delete_undecryptable_records_for_remote_replacement( self: Arc<Self>, ) -> ApiResult<LoginsDeletionMetrics>

pub fn wipe_local(&self) -> ApiResult<()>

pub fn wipe_local_except_fxa(&self) -> ApiResult<()>

pub fn reset(self: Arc<Self>) -> ApiResult<()>

pub fn update(&self, id: &str, entry: LoginEntry) -> ApiResult<Login>

pub fn add(&self, entry: LoginEntry) -> ApiResult<Login>

pub fn add_many( &self, entries: Vec<LoginEntry>, ) -> ApiResult<Vec<BulkResultEntry>>

pub fn add_with_meta( &self, entry_with_meta: LoginEntryWithMeta, ) -> ApiResult<Login>

This method is intended to preserve metadata (LoginMeta) during a migration. In normal operation, this method should not be used; instead, use add(entry), which manages the corresponding fields itself.

pub fn add_many_with_meta( &self, entries_with_meta: Vec<LoginEntryWithMeta>, ) -> ApiResult<Vec<BulkResultEntry>>

pub fn add_or_update(&self, entry: LoginEntry) -> ApiResult<Login>

pub fn run_maintenance( &self, options: Option<RunMaintenanceOptions>, ) -> ApiResult<()>

pub fn shutdown(&self)

pub fn register_with_sync_manager(self: Arc<Self>)

pub fn create_logins_sync_engine( self: Arc<Self>, ) -> ApiResult<Box<dyn SyncEngine>>

impl LoginStore

pub fn bridged_engine(self: Arc<Self>) -> Result<Arc<LoginsBridgedEngine>>

Returns a bridged sync engine for Desktop for this store.

Unlike Tabs, constructing a LoginsSyncEngine locks the DB and can fail, so this is fallible (and exposed as [Throws] in the UDL). The internal error is surfaced via anyhow, which UniFFI maps onto LoginsApiError through From<anyhow::Error>.

Trait Implementations

impl<UT> LiftRef<UT> for LoginStore

type LiftType = Arc<LoginStore>

impl<UT> LowerError<UT> for LoginStore

fn lower_error(obj: Self) -> RustBuffer

Lower this value for scaffolding function return

impl<UT> LowerReturn<UT> for LoginStore

type ReturnType = <Arc<LoginStore> as LowerReturn<UniFfiTag>>::ReturnType

The type that should be returned by scaffolding functions for this type.

fn lower_return(obj: Self) -> Result<Self::ReturnType, RustCallError>

Lower the return value from an scaffolding call

fn handle_failed_lift( error: LiftArgsError, ) -> Result<Self::ReturnType, RustCallError>

Lower the return value for failed argument lifts

impl<UT> TypeId<UT> for LoginStore

const TYPE_ID_META: MetadataBuffer