Struct deltachat::imex::BackupProvider

pub struct BackupProvider {
    handle: JoinHandle<Result<()>>,
    ticket: Ticket,
    _drop_guard: DropGuard,
}

Provide or send a backup of this device.

This creates a backup of the current device and starts a service which offers another device to download this backup.

This does not make a full backup on disk, only the SQLite database is created on disk, the blobs in the blob directory are not copied.

This starts a task which acquires the global “ongoing” mutex. If you need to stop the task use the Context::stop_ongoing mechanism.

The task implements Future and awaiting it will complete once a transfer has been either completed or aborted.

Fields

handle: JoinHandle<Result<()>>

The supervisor task, run by BackupProvider::watch_provider.

ticket: Ticket

The ticket to retrieve the backup collection.

_drop_guard: DropGuard

Guard to cancel the provider on drop.

Implementations

impl BackupProvider

pub async fn prepare(context: &Context) -> Result<Self>

Prepares for sending a backup to a second device.

Before calling this function all I/O must be stopped so that no changes to the blobs or database are happening, this is done by calling the Accounts::stop_io or Context::stop_io APIs first.

This will acquire the global “ongoing process” mutex, which can be used to cancel the process.

async fn prepare_inner( context: &Context, dbfile: &Path ) -> Result<(Provider, Ticket)>

Creates the provider task.

Having this as a function makes it easier to cancel it when needed.

async fn watch_provider( context: &Context, provider: Provider, cancel_token: Receiver<()>, drop_token: CancellationToken ) -> Result<()>

Supervises the iroh [Provider], terminating it when needed.

This will watch the provider and terminate it when:

• A transfer is completed, successful or unsuccessful.
• An event could not be observed to protect against not knowing of a completed event.
• The ongoing process is cancelled.

The cancel_token is the handle for the ongoing process mutex, when this completes we must cancel this operation.

pub fn qr(&self) -> Qr

Returns a QR code that allows fetching this backup.

This QR code can be passed to get_backup on a (different) device.

Trait Implementations

impl Debug for BackupProvider

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

Formats the value using the given formatter.

impl Future for BackupProvider

type Output = Result<(), Error>

The type of value produced on completion.

fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output>

Attempt to resolve the future to a final value, registering the current task for wakeup if the value is not yet available.