Struct OpenAndCompactCancellationToken 

pub struct OpenAndCompactCancellationToken { /* private fields */ }

A flag that aborts an open_and_compact_with_options call from another thread.

Create one, hand it to OpenAndCompactOptions::set_canceled, keep a clone of the Arc somewhere else, and call cancel from that other thread. 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.

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

Implementations

impl OpenAndCompactCancellationToken

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 open_and_compact_with_options call it belongs to then fails.

Trait Implementations

impl Default for OpenAndCompactCancellationToken

fn default() -> Self

Returns the “default value” for a type.

impl Drop for OpenAndCompactCancellationToken

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 OpenAndCompactCancellationToken

impl Sync for OpenAndCompactCancellationToken