Struct CancelToken 

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

A flag a caller can raise to stop a chunked bulk write (0.13.8, W7.6, D-181).

Cheap to clone and safe to set from any thread, which is the whole point: the task running the import is the one thing that cannot cancel it. Hand a clone to whatever can — a signal handler, a UI thread, a timeout task — and it takes effect at the next chunk boundary.

A boundary, not an abort. Nothing rolls back and no in-flight transaction is interrupted: the loop notices between chunks and stops sending. The chunks that committed stay committed, and BulkInterrupted::written says how many rows those were. That is the same per-chunk boundary Database::bulk_import already documents, so cancellation adds a reason to stop and no new failure mode.

Setting it after the last chunk has committed does nothing — a finished write reports success, because it succeeded.

Implementations

impl CancelToken

pub fn new() -> Self

A token that has not been cancelled.

pub fn cancel(&self)

Ask the bulk write holding a clone of this token to stop at its next chunk boundary. Idempotent; a token never un-cancels.

pub fn is_cancelled(&self) -> bool

Whether Self::cancel has been called on this token or any clone.

Trait Implementations

impl Clone for CancelToken

fn clone(&self) -> CancelToken

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CancelToken

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

Formats the value using the given formatter.

impl Default for CancelToken

fn default() -> CancelToken

Returns the “default value” for a type.