Skip to main content

Event

Enum Event 

Source
pub enum Event {
Show 15 variants PasteUpload { id: u64, text: Arc<str>, }, PasteCancelled { id: u64, }, Line(String), Eof, CancelPrompt, Resize { width: u16, height: u16, }, FocusChanged { focused: bool, }, BufferChanged, CompletionRefresh, CompletionAccept, BackTab, Escape, Binding(String), Notice(String), ExternalEditor,
}
Expand description

High-level events surfaced to the downstream event loop.

Variants§

§

PasteUpload

Upload normalized text without exposing it to the editable draft.

Fields

§id: u64

Exact local attempt identity, never a wire or session authority.

§text: Arc<str>

Normalized source retained outside prompt/history presentation.

§

PasteCancelled

Discard the pending paste; the original draft remains unchanged.

Fields

§id: u64

Attempt whose late completion must no longer edit the draft.

§

Line(String)

The user submitted a line with Ctrl-Enter or submit-prompt outside the completion menu, or with no candidate selected.

§

Eof

The user signalled EOF (Ctrl-D on empty line).

§

CancelPrompt

The user requested prompt cancellation with a second consecutive Ctrl-C.

§

Resize

The terminal was resized.

Fields

§width: u16
§height: u16
§

FocusChanged

The terminal reported focus gained or lost.

Fields

§focused: bool
§

BufferChanged

The input buffer or completion menu state changed. Fires for keystrokes that mutate the buffer and for completion menu open/close/cycle. Caller should re-render anything that depends on either (typically the menu and the prompt itself).

§

CompletionRefresh

A background owner requested that the completion menu be recomputed without changing the prompt buffer.

§

CompletionAccept

The user pressed Ctrl-Enter with a candidate previewed in the menu. The buffer is now the candidate’s accepted replacement and completion has been re-evaluated for that buffer. The caller should re-render the menu area but typically should not submit — a second Ctrl-Enter is expected to confirm.

§

BackTab

The user pressed Shift-Tab outside an open completion menu. Inside a menu it cycles backwards and is consumed internally.

§

Escape

The user pressed Escape outside an open completion menu.

§

Binding(String)

The user activated a configured key binding.

§

Notice(String)

A local prompt notice should be printed above the prompt.

§

ExternalEditor

The user requested an external editor (Ctrl-O / Ctrl-G). Caller is expected to call Term::pause_for_external, spawn $VISUAL/$EDITOR, and call Term::resume_after_external.

Auto Trait Implementations§

§

impl Freeze for Event

§

impl RefUnwindSafe for Event

§

impl Send for Event

§

impl Sync for Event

§

impl Unpin for Event

§

impl UnsafeUnpin for Event

§

impl UnwindSafe for Event

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 = !

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

fn try_from(value: U) -> Result<T, !>

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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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