Struct BackupProvider

pub struct BackupProvider {
    _endpoint: Endpoint,
    node_addr: NodeAddr,
    auth_token: String,
    handle: JoinHandle<Result<()>>,
    _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.

Fields

_endpoint: Endpoint

iroh-net endpoint.

node_addr: NodeAddr

iroh-net address.

auth_token: String

Authentication token that should be submitted to retrieve the backup.

handle: JoinHandle<Result<()>>

Handle for the task accepting backup transfer requests.

_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 handle_connection( context: Context, conn: Connecting, auth_token: String, dbfile: Arc<TempPathGuard>, ) -> Result<()>

async fn accept_loop( context: Context, endpoint: Endpoint, auth_token: String, cancel_token: Receiver<()>, drop_token: CancellationToken, dbfile: TempPathGuard, )

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

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

Waits for the backup transfer to complete.

type Output = Result<(), Error>

The type of value produced on completion.