Struct EventEnvelope

#[non_exhaustive]
pub struct EventEnvelope { /* private fields */ }

Runtime event together with host correlation and presentation metadata.

The envelope does not validate that optional pointer metadata corresponds to an Event::Pointer, or that its logical window/generation is currently accepted. Routing/presentation orchestration owns those checks. The struct is non-exhaustive and exposes data through accessors.

Examples

use std::time::Duration;
use ailloli_ui_core::event::{Event, FocusEvent};
use ailloli_ui_runtime::{app::PresentationGeneration, input::{EventEnvelope, EventId, EventMeta, EventTimestamp}};
let meta = EventMeta::new(EventId::new(1), EventTimestamp::new(Duration::ZERO), "main", PresentationGeneration::INITIAL);
let envelope = EventEnvelope::new(meta, Event::Focus(FocusEvent::new(true)));
assert!(matches!(envelope.event(), Event::Focus(_)));

Implementations

impl EventEnvelope

Provides the operations defined for EventEnvelope.

pub const fn new(meta: EventMeta, event: Event) -> Self

Combines metadata and an event without cross-validating them.

Examples

use std::time::Duration;
use ailloli_ui_core::event::{Event, FocusEvent};
use ailloli_ui_runtime::{app::PresentationGeneration, input::{EventEnvelope, EventId, EventMeta, EventTimestamp}};
let meta = EventMeta::new(EventId::new(2), EventTimestamp::new(Duration::ZERO), "main", PresentationGeneration::INITIAL);
let envelope = EventEnvelope::new(meta, Event::Focus(FocusEvent::new(false)));
assert_eq!(envelope.meta().id(), EventId::new(2));

pub const fn meta(&self) -> &EventMeta

Borrows host correlation and presentation metadata.

Examples

use std::time::Duration;
use ailloli_ui_core::event::{Event, FocusEvent};
use ailloli_ui_runtime::{app::PresentationGeneration, input::{EventEnvelope, EventId, EventMeta, EventTimestamp}};
let envelope = EventEnvelope::new(EventMeta::new(EventId::new(7), EventTimestamp::new(Duration::ZERO), "main", PresentationGeneration::INITIAL), Event::Focus(FocusEvent::new(true)));
assert_eq!(envelope.meta().id().get(), 7);

pub const fn event(&self) -> &Event

Borrows the provider-neutral event payload.

Examples

use std::time::Duration;
use ailloli_ui_core::event::{Event, FocusEvent};
use ailloli_ui_runtime::{app::PresentationGeneration, input::{EventEnvelope, EventId, EventMeta, EventTimestamp}};
let envelope = EventEnvelope::new(EventMeta::new(EventId::new(1), EventTimestamp::new(Duration::ZERO), "main", PresentationGeneration::INITIAL), Event::Focus(FocusEvent::new(true)));
assert!(matches!(envelope.event(), Event::Focus(event) if event.focused));

pub const fn pointer(&self) -> Option<&PointerSample>

Pointer sample carried by this envelope, when the event has one.

This delegates to metadata rather than inspecting the event variant.

Examples

use std::time::Duration;
use ailloli_ui_core::event::{Event, FocusEvent};
use ailloli_ui_runtime::{app::PresentationGeneration, input::{EventEnvelope, EventId, EventMeta, EventTimestamp}};
let envelope = EventEnvelope::new(EventMeta::new(EventId::new(1), EventTimestamp::new(Duration::ZERO), "main", PresentationGeneration::INITIAL), Event::Focus(FocusEvent::new(true)));
assert_eq!(envelope.pointer(), None);

pub const fn pointer_is_primary(&self) -> Option<bool>

Returns the envelope’s explicit primary-pointer classification.

None means no sample was attached, not a secondary pointer.

Examples

use std::time::Duration;
use ailloli_ui_core::event::{Event, FocusEvent};
use ailloli_ui_runtime::{app::PresentationGeneration, input::{EventEnvelope, EventId, EventMeta, EventTimestamp}};
let envelope = EventEnvelope::new(EventMeta::new(EventId::new(1), EventTimestamp::new(Duration::ZERO), "main", PresentationGeneration::INITIAL), Event::Focus(FocusEvent::new(true)));
assert_eq!(envelope.pointer_is_primary(), None);

pub fn into_parts(self) -> (EventMeta, Event)

Consumes the envelope and returns (metadata, event) without cloning.

Examples

use std::time::Duration;
use ailloli_ui_core::event::{Event, FocusEvent};
use ailloli_ui_runtime::{app::PresentationGeneration, input::{EventEnvelope, EventId, EventMeta, EventTimestamp}};
let envelope = EventEnvelope::new(EventMeta::new(EventId::new(5), EventTimestamp::new(Duration::ZERO), "main", PresentationGeneration::INITIAL), Event::Focus(FocusEvent::new(true)));
let (meta, event) = envelope.into_parts();
assert_eq!(meta.id().get(), 5);
assert!(matches!(event, Event::Focus(_)));

Trait Implementations

impl Clone for EventEnvelope

fn clone(&self) -> EventEnvelope

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EventEnvelope

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

Formats the value using the given formatter.

impl PartialEq for EventEnvelope

fn eq(&self, other: &EventEnvelope) -> 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 StructuralPartialEq for EventEnvelope