Struct CompactionCancellationToken 

pub struct CompactionCancellationToken { /* private fields */ }

A cancellation flag that aborts an in progress CompactFiles job.

Create one, hand it to CompactionOptions::set_canceled, keep a clone of the Arc somewhere else, and call cancel from that other thread to stop the compaction. Cancellation is one shot and best effort. The compaction iterator checks the flag as it walks the input, so the job stops at the next check rather than immediately, and upstream notes that cancellation can be delayed waiting on automatic compactions when exclusive_manual_compaction is set.

There is no C API to read the flag back, so this wrapper is write only and there is no way to un-cancel. Use a fresh token per compaction.

Implementations

impl CompactionCancellationToken

pub fn new() -> Self

Allocates a fresh token in the not cancelled state.

pub fn cancel(&self)

Signals that the compaction using this token should stop.

Returns as soon as the flag is stored. The compaction winds down on its own thread and the CompactFiles call it belongs to then fails with ErrorKind::Incomplete and the message Result incomplete: Manual compaction paused.

Trait Implementations

impl Default for CompactionCancellationToken

fn default() -> Self

Returns the “default value” for a type.

impl Drop for CompactionCancellationToken

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl Send for CompactionCancellationToken

impl Sync for CompactionCancellationToken