Skip to main content

EventArgs

Struct EventArgs 

Source
pub struct EventArgs {
    pub event_type: EventType,
    pub window: Option<ObjectHandle>,
    pub pane: Option<ObjectHandle>,
    pub tab: Option<ObjectHandle>,
    pub data: EventData,
    pub timestamp: Instant,
}
Expand description

Event arguments passed to handlers

Contains all contextual information about an event, including:

  • The event type
  • Handles to affected terminal objects (window, pane, tab)
  • Event-specific data payload
  • Timestamp when the event occurred

Fields§

§event_type: EventType

Type of event being fired

§window: Option<ObjectHandle>

Handle to the window associated with this event (if any)

§pane: Option<ObjectHandle>

Handle to the pane associated with this event (if any)

§tab: Option<ObjectHandle>

Handle to the tab associated with this event (if any)

§data: EventData

Event-specific data payload

§timestamp: Instant

When this event was created

Implementations§

Source§

impl EventArgs

Source

pub fn new(event_type: EventType) -> Self

Create new event arguments

Source

pub fn with_window(self, handle: ObjectHandle) -> Self

Set the window handle (builder pattern)

Source

pub fn with_pane(self, handle: ObjectHandle) -> Self

Set the pane handle (builder pattern)

Source

pub fn with_tab(self, handle: ObjectHandle) -> Self

Set the tab handle (builder pattern)

Source

pub fn with_data(self, data: EventData) -> Self

Set the event data (builder pattern)

Source

pub fn data(&self) -> &EventData

Get a reference to the event data

Source

pub fn has_window(&self) -> bool

Check if this event has window context

Source

pub fn has_pane(&self) -> bool

Check if this event has pane context

Source

pub fn has_tab(&self) -> bool

Check if this event has tab context

Source

pub fn age(&self) -> Duration

Get the age of this event

Trait Implementations§

Source§

impl Clone for EventArgs

Source§

fn clone(&self) -> EventArgs

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 EventArgs

Source§

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

Formats the value using the given formatter. Read more

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

Source§

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.
Source§

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.
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<F, W, T, D> Deserialize<With<T, W>, D> for F
where W: DeserializeWith<F, T, D>, D: Fallible + ?Sized, F: ?Sized,

Source§

fn deserialize( &self, deserializer: &mut D, ) -> Result<With<T, W>, <D as Fallible>::Error>

Deserializes using the given deserializer
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> LayoutRaw for T

Source§

fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>

Gets the layout of the type.
Source§

impl<T> Pointee for T

Source§

type Metadata = ()

The type for metadata in pointers and references to Self.
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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V