Trait Backend 

pub trait Backend:
    Debug
    + Send
    + Sync {
    type Session: BackendSession + 'static;

    // Required methods
    fn create_profile(
        &self,
        name: Option<String>,
    ) -> BoxFuture<'_, Result<String, Error>>;
    fn get_active_profile(&self) -> String;
    fn get_default_profile(&self) -> BoxFuture<'_, Result<String, Error>>;
    fn set_default_profile(
        &self,
        profile: String,
    ) -> BoxFuture<'_, Result<(), Error>>;
    fn list_profiles(&self) -> BoxFuture<'_, Result<Vec<String>, Error>>;
    fn remove_profile(&self, name: String) -> BoxFuture<'_, Result<bool, Error>>;
    fn rename_profile(
        &self,
        from_name: String,
        to_name: String,
    ) -> BoxFuture<'_, Result<bool, Error>>;
    fn scan(
        &self,
        profile: Option<String>,
        kind: Option<EntryKind>,
        category: Option<String>,
        tag_filter: Option<TagFilter>,
        offset: Option<i64>,
        limit: Option<i64>,
        order_by: Option<OrderBy>,
        descending: bool,
    ) -> BoxFuture<'_, Result<Scan<'static, Entry>, Error>>;
    fn session(
        &self,
        profile: Option<String>,
        transaction: bool,
    ) -> Result<Self::Session, Error>;
    fn rekey(
        &mut self,
        method: StoreKeyMethod,
        key: PassKey<'_>,
    ) -> BoxFuture<'_, Result<(), Error>>;
    fn close(&self) -> BoxFuture<'_, Result<(), Error>>;
}

Represents a generic backend implementation

Required Associated Types

type Session: BackendSession + 'static

The type of session managed by this backend

Required Methods

fn create_profile( &self, name: Option<String>, ) -> BoxFuture<'_, Result<String, Error>>

Create a new profile

fn get_active_profile(&self) -> String

Get the name of the active profile

fn get_default_profile(&self) -> BoxFuture<'_, Result<String, Error>>

Get the name of the default profile

fn set_default_profile( &self, profile: String, ) -> BoxFuture<'_, Result<(), Error>>

Set the the default profile

fn list_profiles(&self) -> BoxFuture<'_, Result<Vec<String>, Error>>

Get the details of all store profiles

fn remove_profile(&self, name: String) -> BoxFuture<'_, Result<bool, Error>>

Remove an existing profile

fn rename_profile( &self, from_name: String, to_name: String, ) -> BoxFuture<'_, Result<bool, Error>>

Change the name of an existing profile

fn scan( &self, profile: Option<String>, kind: Option<EntryKind>, category: Option<String>, tag_filter: Option<TagFilter>, offset: Option<i64>, limit: Option<i64>, order_by: Option<OrderBy>, descending: bool, ) -> BoxFuture<'_, Result<Scan<'static, Entry>, Error>>

Create a Scan against the store

fn session( &self, profile: Option<String>, transaction: bool, ) -> Result<Self::Session, Error>

Create a new session against the store

fn rekey( &mut self, method: StoreKeyMethod, key: PassKey<'_>, ) -> BoxFuture<'_, Result<(), Error>>

Replace the wrapping key of the store

fn close(&self) -> BoxFuture<'_, Result<(), Error>>

Close the store instance

Dyn Compatibility

This trait is dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementors

impl Backend for AnyBackend

Available on crate feature any only.

type Session = AnyBackendSession

impl Backend for PostgresBackend

Available on crate feature postgres only.

type Session = DbSession<Postgres>

impl Backend for SqliteBackend

Available on crate feature sqlite only.

type Session = DbSession<Sqlite>