Skip to main content

ScriptEventData

Enum ScriptEventData 

Source
pub enum ScriptEventData {
    Empty {},
    CwdChanged {
        cwd: String,
    },
    CommandComplete {
        command: String,
        exit_code: Option<i32>,
    },
    TitleChanged {
        title: String,
    },
    SizeChanged {
        cols: usize,
        rows: usize,
    },
    VariableChanged {
        name: String,
        value: String,
        old_value: Option<String>,
    },
    EnvironmentChanged {
        key: String,
        value: String,
        old_value: Option<String>,
    },
    BadgeChanged {
        text: Option<String>,
    },
    TriggerMatched {
        pattern: String,
        matched_text: String,
        line: usize,
    },
    ZoneEvent {
        zone_id: u64,
        zone_type: String,
        event: String,
    },
    Generic {
        fields: HashMap<String, Value>,
    },
}
Expand description

Event-specific payload data.

Tagged with data_type so the JSON includes a discriminant field for Python scripts to easily dispatch on.

Variants§

§

Empty

Empty payload for events that carry no additional data (e.g., BellRang).

§

CwdChanged

The current working directory changed.

Fields

§cwd: String

New working directory path.

§

CommandComplete

A command completed execution.

Fields

§command: String

The command that completed.

§exit_code: Option<i32>

Exit code, if available.

§

TitleChanged

The terminal title changed.

Fields

§title: String

New terminal title.

§

SizeChanged

The terminal size changed.

Fields

§cols: usize

Number of columns.

§rows: usize

Number of rows.

§

VariableChanged

A user variable changed.

Fields

§name: String

Variable name.

§value: String

New value.

§old_value: Option<String>

Previous value, if any.

§

EnvironmentChanged

An environment variable changed.

Fields

§key: String

Environment variable key.

§value: String

New value.

§old_value: Option<String>

Previous value, if any.

§

BadgeChanged

The badge text changed.

Fields

§text: Option<String>

New badge text, or None if cleared.

§

TriggerMatched

A trigger pattern was matched.

Fields

§pattern: String

The trigger pattern that matched.

§matched_text: String

The text that matched.

§line: usize

Line number where the match occurred.

§

ZoneEvent

A semantic zone event occurred.

Fields

§zone_id: u64

Zone identifier.

§zone_type: String

Type of zone.

§event: String

Event type (e.g., “enter”, “exit”).

§

Generic

Fallback for unmapped events. Carries arbitrary key-value fields.

Fields

§fields: HashMap<String, Value>

Arbitrary event fields.

Trait Implementations§

Source§

impl Clone for ScriptEventData

Source§

fn clone(&self) -> ScriptEventData

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ScriptEventData

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for ScriptEventData

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for ScriptEventData

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl Serialize for ScriptEventData

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for ScriptEventData

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,