Struct BulkControl 

pub struct BulkControl { /* private fields */ }

Cancellation and progress for the four chunked bulk paths (0.13.8, W7.6, D-181).

Default is “neither”, which is what Database::bulk_import and its three siblings pass. The _with variants take one of these:

let token = CancelToken::new();
let stopper = token.clone();
tokio::spawn(async move {
    tokio::time::sleep(std::time::Duration::from_secs(30)).await;
    stopper.cancel();
});

let control = BulkControl::new()
    .cancel_with(token)
    .on_progress(|p| println!("{}/{} rows", p.written, p.total));

match db.bulk_import_with(edges, control).await {
    Ok(n) => println!("imported {n}"),
    Err(e) => println!("stopped after {}: {}", e.written, e.cause),
}

The callback runs on the importing task, between chunks. It is therefore on the critical path: whatever it does is time the next chunk is not being sent in. Printing or updating a counter is what it is for; a blocking write is not, and neither is anything that calls back into the same Database, which would deadlock the loop against a channel it is itself draining.

Implementations

impl BulkControl

pub fn new() -> Self

Neither cancellation nor progress — what the plain bulk methods pass.

pub fn cancel_with(self, token: CancelToken) -> Self

Stop at the next chunk boundary when token is cancelled.

pub fn on_progress( self, f: impl Fn(BulkProgress) + Send + Sync + 'static, ) -> Self

Call f after every chunk commits. See the note on BulkControl about what this closure is allowed to do.

Trait Implementations

impl Clone for BulkControl

fn clone(&self) -> BulkControl

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for BulkControl

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

Formats the value using the given formatter.

impl Default for BulkControl

fn default() -> BulkControl

Returns the “default value” for a type.