Struct EncryptedPool 

pub struct EncryptedPool(/* private fields */);

Implementations

impl EncryptedPool

pub fn new(storage_path: &impl ToString) -> Self

pub fn new_tmp() -> Self

Creates an unsealed temporary pool which is useful when writing tests.

pub fn state(&self) -> StorageState

pub fn initialize(&self) -> Result<Option<String>, EncryptedPoolError>

Initialize the pool.

Errors

Returns error if the pool is not uninitialized or the initialization fails.

pub fn unseal(&self, master_key: String) -> Result<(), EncryptedPoolError>

Unseal the pool.

Errors

Returns error if the pool is not sealed or the unseal process fails.

pub fn seal(&self) -> Result<(), EncryptedPoolError>

Seal the pool.

Errors

Returns error if the pool is not unsealed.

pub async fn begin(&self) -> Result<Transaction<'static, Sqlite>, Error>

Retrieves a connection and immediately begins a new transaction.

Errors

Returns error if it is unable to retrieve the db pool or start the transaction.

Trait Implementations

impl<'c> Acquire<'c> for &EncryptedPool

type Database = Sqlite

type Connection = PoolConnection<Sqlite>

fn acquire(self) -> BoxFuture<'c, Result<Self::Connection, Error>>

fn begin(self) -> BoxFuture<'c, Result<Transaction<'c, Self::Database>, Error>>

impl Debug for EncryptedPool

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

Formats the value using the given formatter.

impl<'c> Executor<'c> for &EncryptedPool

type Database = Sqlite

fn fetch_many<'e, 'q, E>( self, query: E, ) -> BoxStream<'e, Result<Either<<Self::Database as Database>::QueryResult, <Self::Database as Database>::Row>, Error>>

where E: 'q + Execute<'q, Self::Database>, 'c: 'e, 'q: 'e,

Execute multiple queries and return the generated results as a stream from each query, in a stream.

fn fetch_optional<'e, 'q, E>( self, query: E, ) -> BoxFuture<'e, Result<Option<<Self::Database as Database>::Row>, Error>>

where E: 'q + Execute<'q, Self::Database>, 'c: 'e, 'q: 'e,

Execute the query and returns at most one row.

fn prepare_with<'e, 'q: 'e>( self, sql: &'q str, parameters: &'e [<Self::Database as Database>::TypeInfo], ) -> BoxFuture<'e, Result<<Self::Database as HasStatement<'q>>::Statement, Error>>

where 'c: 'e,

Prepare the SQL query, with parameter type information, to inspect the type information about its parameters and results.

fn execute<'e, 'q, E>( self, query: E, ) -> Pin<Box<dyn Future<Output = Result<<Self::Database as Database>::QueryResult, Error>> + Send + 'e>>

where 'q: 'e, 'c: 'e, E: 'q + Execute<'q, Self::Database>,

Execute the query and return the total number of rows affected.

fn execute_many<'e, 'q, E>( self, query: E, ) -> Pin<Box<dyn Stream<Item = Result<<Self::Database as Database>::QueryResult, Error>> + Send + 'e>>

where 'q: 'e, 'c: 'e, E: 'q + Execute<'q, Self::Database>,

Execute multiple queries and return the rows affected from each query, in a stream.

fn fetch<'e, 'q, E>( self, query: E, ) -> Pin<Box<dyn Stream<Item = Result<<Self::Database as Database>::Row, Error>> + Send + 'e>>

where 'q: 'e, 'c: 'e, E: 'q + Execute<'q, Self::Database>,

Execute the query and return the generated results as a stream.

fn fetch_all<'e, 'q, E>( self, query: E, ) -> Pin<Box<dyn Future<Output = Result<Vec<<Self::Database as Database>::Row>, Error>> + Send + 'e>>

where 'q: 'e, 'c: 'e, E: 'q + Execute<'q, Self::Database>,

Execute the query and return all the generated results, collected into a Vec.

fn fetch_one<'e, 'q, E>( self, query: E, ) -> Pin<Box<dyn Future<Output = Result<<Self::Database as Database>::Row, Error>> + Send + 'e>>

where 'q: 'e, 'c: 'e, E: 'q + Execute<'q, Self::Database>,

Execute the query and returns exactly one row.

fn prepare<'e, 'q>( self, query: &'q str, ) -> Pin<Box<dyn Future<Output = Result<<Self::Database as HasStatement<'q>>::Statement, Error>> + Send + 'e>>

where 'q: 'e, 'c: 'e,

Prepare the SQL query to inspect the type information of its parameters and results.