Struct Envelope 

pub struct Envelope<E> { /* private fields */ }

The unit carried through all Maiko channels.

Every event in the system travels as Arc<Envelope<E>> - from producer through the broker to each subscriber’s mailbox. It pairs the user-defined event payload with Meta (sender, timestamp, parent ID).

Implementations

impl<E> Envelope<E>

pub fn new(event: E, actor_id: ActorId) -> Self

Create a new envelope tagging the event with the given actor name.

pub fn with_parent_id(self, parent_id: EventId) -> Self

Set the parent event ID for causality tracking.

Prefer Context::send_child_event which sets this automatically. Use with_parent_id directly only when constructing envelopes outside the normal actor context (e.g., in test setup or bridges).

pub fn event(&self) -> &E

Returns a reference to the event payload.

This is a convenience method for pattern matching.

Example

match envelope.event() {
    MyEvent::Foo(x) => handle_foo(x),
    MyEvent::Bar => handle_bar(),
}

pub fn meta(&self) -> &Meta

Returns the event metadata (sender, timestamp, parent ID).

pub fn id(&self) -> EventId

Shorthand for self.meta().id().

Trait Implementations

impl<E: Clone> Clone for Envelope<E>

fn clone(&self) -> Envelope<E>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<E: Debug> Debug for Envelope<E>

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

Formats the value using the given formatter.

impl<'de, E> Deserialize<'de> for Envelope<E>

where E: DeserializeOwned,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<E: Display> Display for Envelope<E>

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

Formats the value using the given formatter.

impl<E> From<Envelope<E>> for IntoEnvelope<E>

fn from(value: Envelope<E>) -> Self

Converts to this type from the input type.

impl<E: Hash> Hash for Envelope<E>

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<E: PartialEq> PartialEq for Envelope<E>

fn eq(&self, other: &Self) -> 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<E> Serialize for Envelope<E>

where E: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<E: Eq> Eq for Envelope<E>