Skip to main content

ScriptEventForwarder

Struct ScriptEventForwarder 

Source
pub struct ScriptEventForwarder { /* private fields */ }
Expand description

Bridge between core terminal observer events and the scripting JSON protocol.

Register an Arc<ScriptEventForwarder> with Terminal::add_observer(). The forwarder buffers converted events; the owner drains them via [drain_events] and serialises them to script sub-processes.

Implementations§

Source§

impl ScriptEventForwarder

Source

pub fn new(subscriptions: Option<HashSet<String>>) -> Self

Create a new forwarder.

§Arguments
  • subscriptions - If Some, only events whose snake_case kind name is in the set will be captured. If None, all events are captured.
Source

pub fn drain_events(&self) -> Vec<ScriptEvent>

Drain all buffered events, returning them and clearing the buffer.

Trait Implementations§

Source§

impl TerminalObserver for ScriptEventForwarder

Source§

fn on_event(&self, event: &TerminalEvent)

Called for ALL events (catch-all). Called after category-specific methods.
Source§

fn on_zone_event(&self, _event: &TerminalEvent)

Called for zone lifecycle events (ZoneOpened, ZoneClosed, ZoneScrolledOut)
Source§

fn on_command_event(&self, _event: &TerminalEvent)

Called for command/shell integration events (ShellIntegrationEvent)
Source§

fn on_environment_event(&self, _event: &TerminalEvent)

Called for environment changes (CwdChanged, EnvironmentChanged, RemoteHostTransition, SubShellDetected)
Source§

fn on_screen_event(&self, _event: &TerminalEvent)

Called for screen content events (BellRang, TitleChanged, SizeChanged, ModeChanged, GraphicsAdded, HyperlinkAdded, DirtyRegion, UserVarChanged, ProgressBarChanged, BadgeChanged, TriggerMatched)
Source§

fn subscriptions(&self) -> Option<&HashSet<TerminalEventKind>>

Which event kinds this observer is interested in (None = all)

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> 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 + Send + Sync>

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, 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.