Skip to main content

PaneInteractionGuard

Struct PaneInteractionGuard 

Source
pub struct PaneInteractionGuard<'a> { /* private fields */ }
Expand description

RAII guard that ensures pane interaction state is cleanly canceled on drop.

When a pane interaction session is active and the guard drops (due to panic, scope exit, or any other unwind), it force-cancels any in-progress drag/resize and collects cleanup diagnostics.

§Usage

let guard = PaneInteractionGuard::new(&mut adapter);
// ... pane interaction event loop ...
// If this scope panics, guard's Drop will force-cancel the drag machine
let diagnostics = guard.finish(); // explicit clean finish

Implementations§

Source§

impl<'a> PaneInteractionGuard<'a>

Source

pub fn new(adapter: &'a mut PaneTerminalAdapter) -> Self

Create a new guard wrapping the given adapter.

Source

pub fn adapter(&mut self) -> &mut PaneTerminalAdapter

Access the wrapped adapter for normal event translation.

Source

pub fn finish(self) -> Option<PaneCleanupDiagnostics>

Explicitly finish the guard, returning any cleanup diagnostics.

Calling finish() is optional — the guard will also clean up on drop. However, finish() gives the caller access to the diagnostics.

Trait Implementations§

Source§

impl Drop for PaneInteractionGuard<'_>

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more