pub enum ScriptEventData {
Show 13 variants
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,
},
PluginActionInvoked {
action: String,
},
Generic {
fields: HashMap<String, Value>,
},
OverlayEvent {
overlay: String,
widget: String,
event: OverlayWidgetEvent,
},
}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.
CommandComplete
A command completed execution.
TitleChanged
The terminal title changed.
SizeChanged
The terminal size changed.
VariableChanged
A user variable changed.
Fields
EnvironmentChanged
An environment variable changed.
Fields
BadgeChanged
The badge text changed.
TriggerMatched
A trigger pattern was matched.
Fields
ZoneEvent
A semantic zone event occurred.
Fields
PluginActionInvoked
A plugin-contributed palette action was invoked.
Tab scripts never receive this variant: it is written directly to the contributing plugin process’s stdin when the host invokes one of its actions, and is never routed through the observer fan-out that carries other events to scripts.
Generic
Fallback for unmapped events. Carries arbitrary key-value fields.
OverlayEvent
A semantic event from a focused interactive overlay’s own widget (overlay kind only). Written directly to the overlay process’s stdin when the host’s renderer reports a widget interaction — never raw keys (design: input & focus routing).
Trait Implementations§
Source§impl Clone for ScriptEventData
impl Clone for ScriptEventData
Source§impl Debug for ScriptEventData
impl Debug for ScriptEventData
Source§impl<'de> Deserialize<'de> for ScriptEventData
impl<'de> Deserialize<'de> for ScriptEventData
Source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Source§impl PartialEq for ScriptEventData
impl PartialEq for ScriptEventData
Source§impl Serialize for ScriptEventData
impl Serialize for ScriptEventData
impl StructuralPartialEq for ScriptEventData
Auto Trait Implementations§
impl Freeze for ScriptEventData
impl RefUnwindSafe for ScriptEventData
impl Send for ScriptEventData
impl Sync for ScriptEventData
impl Unpin for ScriptEventData
impl UnsafeUnpin for ScriptEventData
impl UnwindSafe for ScriptEventData
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> DeserializeOwned for Twhere
T: for<'de> Deserialize<'de>,
Source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
Source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
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>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
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)
fn as_any(&self) -> &(dyn Any + 'static)
&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)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&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
impl<T> DowncastSync for T
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
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