Enum HostEventClass 

pub enum HostEventClass {
    AttachTransition,
    InputAccessibility,
    InputComposition,
    InputCompositionTrace,
    InputFocus,
    InputKey,
    InputMouse,
    InputPaste,
    InputTouch,
    InputVtBytes,
    InputWheel,
    TerminalProgress,
    TerminalReplyBytes,
    UiAccessibilityAnnouncement,
    UiLinkClick,
}

Canonical, host-observable event classes (eventSchemaVersion = 1.0.0).

The wire strings and their order match the Host Event Taxonomy section of docs/spec/frankenterm-web-api.md exactly. The list is monotonically sorted by wire string, which the contract guarantees for apiContract().eventTypes.

Variants

AttachTransition

attach.transition — websocket attach state-machine transitions.

InputAccessibility

input.accessibility — assistive-technology originated input.

InputComposition

input.composition — IME composition lifecycle.

InputCompositionTrace

input.composition_trace — IME rewrite/diagnostic trace.

InputFocus

input.focus — focus gained/lost.

InputKey

input.key — key press/release.

InputMouse

input.mouse — mouse button/motion.

InputPaste

input.paste — bracketed paste payload.

InputTouch

input.touch — touch input.

InputVtBytes

input.vt_bytes — raw VT byte chunk forwarded to the PTY.

InputWheel

input.wheel — wheel/scroll input.

TerminalProgress

terminal.progress — OSC 9;4 progress signal.

TerminalReplyBytes

terminal.reply_bytes — terminal-generated reply bytes.

UiAccessibilityAnnouncement

ui.accessibility_announcement — live-region announcement for the host.

UiLinkClick

ui.link_click — host-actionable hyperlink activation.

Implementations

impl HostEventClass

pub const ALL: [HostEventClass; 15]

All event classes in canonical (sorted) order.

pub const fn as_str(self) -> &'static str

Canonical dotted wire string (stable for the 1.x schema line).

pub fn namespace(self) -> &'static str

Namespace prefix (attach / input / terminal / ui).

pub fn from_wire(value: &str) -> Option<Self>

Parse a wire string back to its class (inverse of Self::as_str).

Trait Implementations

impl Clone for HostEventClass

fn clone(&self) -> HostEventClass

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for HostEventClass

impl Debug for HostEventClass

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

Formats the value using the given formatter.

impl Display for HostEventClass

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

Formats the value using the given formatter.

impl Eq for HostEventClass

impl Hash for HostEventClass

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for HostEventClass

fn cmp(&self, other: &HostEventClass) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for HostEventClass

fn eq(&self, other: &HostEventClass) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for HostEventClass

fn partial_cmp(&self, other: &HostEventClass) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for HostEventClass