Struct ConnectionGuard

Source

pub struct ConnectionGuard<'a> { /* private fields */ }

Expand description

Exclusive access to the database connection

Note that this is only ever constructed when we already hold exclusive access, and the connection has already been tested to ensure that it is non-empty.

Methods from Deref<Target = KeystoreDatabaseConnection>§

Source

pub async fn conn(&self) -> MutexGuard<'_, Connection>

Source

pub async fn export_copy( &self, destination_path: &str, ) -> CryptoKeystoreResult<()>

Export a copy of the database to the specified path using VACUUM INTO.

This creates a fully vacuumed and optimized copy of the database. The copy will be encrypted with the same key as the source database.

§Arguments

destination_path - The file path where the database copy should be created

§Errors

Returns an error if:

The database is in-memory (cannot export in-memory databases)
The destination path is invalid
The VACUUM INTO operation fails

Trait Implementations§

Source §

impl Deref for ConnectionGuard<'_>

Source §

type Target = SqlCipherConnection

The resulting type after dereferencing.

Source §

fn deref(&self) -> &Self::Target

Dereferences the value.

Source §

impl DerefMut for ConnectionGuard<'_>

Source §

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

Source §

impl<'a> TryFrom<MutexGuard<'a, Option<SqlCipherConnection>>> for ConnectionGuard<'a>

Source §

type Error = CryptoKeystoreError

The type returned in the event of a conversion error.

Source §

fn try_from( guard: MutexGuard<'a, Option<KeystoreDatabaseConnection>>, ) -> Result<Self, Self::Error>

Performs the conversion.

Auto Trait Implementations§

§

impl<'a> !UnwindSafe for ConnectionGuard<'a>

Blanket Implementations§

Source §

impl<T> Any for T
where T: 'static + ?Sized,

Source §

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

Source §

impl<T> Borrow<T> for T
where T: ?Sized,

Source §

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

Source §

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source §

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

impl<T, U> Into for T
where U: From<T>,

Source §

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source §

impl<T> IntoEither for T

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §