Struct CaptureHandle 

pub struct CaptureHandle { /* private fields */ }

RAII handle for an armed key-capture session.

Dropping the handle cancels the capture if it has not already fired — the pattern matches ObserverHandle elsewhere in the framework. Widgets that arm a capture should hold onto the handle (typically in their own state) so destruction of the widget tears the capture down cleanly.

The handle refers to its own slot, not whatever capture is currently armed; calling begin_key_capture twice creates two independent slots. Dropping the old handle cancels only the old slot (already orphaned by the new call) — it cannot race-cancel a newer capture.

Implementations

impl CaptureHandle

pub fn is_armed(&self) -> bool

Whether this handle’s capture is still armed (true) or has already fired / been cancelled (false).

pub fn cancel(self)

Cancel this handle’s capture explicitly. Equivalent to dropping the handle; exposed for callers that want the cancellation to happen at a precise point rather than at scope end.

Trait Implementations

impl Debug for CaptureHandle

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

Formats the value using the given formatter.

impl Drop for CaptureHandle

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.