Struct SupervisorEvent 

pub struct SupervisorEvent {
    pub when: When,
    pub where: Where,
    pub what: What,
    pub policy: Option<PolicyDecision>,
    pub sequence: EventSequence,
    pub correlation_id: CorrelationId,
    pub config_version: u64,
}

Complete lifecycle event envelope.

Fields

when: When

Time information for the lifecycle fact.

where: Where

Location information for the lifecycle fact.

what: What

Typed event payload.

policy: Option<PolicyDecision>

Optional policy decision related to the event.

sequence: EventSequence

Monotonic event sequence.

correlation_id: CorrelationId

Correlation identifier shared by related signals.

config_version: u64

Configuration version that produced this fact.

Implementations

impl SupervisorEvent

pub fn new( when: When, where: Where, what: What, sequence: EventSequence, correlation_id: CorrelationId, config_version: u64, ) -> Self

Creates a supervisor lifecycle event.

Arguments

• when: Event timing.
• r#where: Event location.
• what: Event payload.
• sequence: Monotonic event sequence.
• correlation_id: Correlation identifier for related signals.
• config_version: Configuration version for this event.

Returns

Returns a SupervisorEvent.

Examples

let event = rust_supervisor::event::payload::SupervisorEvent::new(
    rust_supervisor::event::time::When::new(
        rust_supervisor::event::time::EventTime::deterministic(
            1,
            1,
            0,
            rust_supervisor::id::types::Generation::initial(),
            rust_supervisor::id::types::Attempt::first(),
        ),
    ),
    rust_supervisor::event::payload::Where::new(
        rust_supervisor::id::types::SupervisorPath::root(),
    ),
    rust_supervisor::event::payload::What::ChildRunning { transition: None },
    rust_supervisor::event::time::EventSequence::new(1),
    rust_supervisor::event::time::CorrelationId::from_uuid(uuid::Uuid::nil()),
    1,
);
assert_eq!(event.what.name(), "ChildRunning");

Examples found in repository

examples/diagnostic_replay.rs (lines 207-233)

fn event(
    // Receive the event sequence number.
    sequence: u64,
    // Receive the child identifier.
    child_id: ChildId,
    // Receive the child display name.
    child_name: &str,
    // Receive the event payload.
    what: What,
    // Receive the optional policy decision.
    policy: Option<PolicyDecision>,
    // Return the built supervisor event.
) -> SupervisorEvent {
    // Build the event sequence value.
    let sequence_value = EventSequence::new(sequence);
    // Build the base event envelope.
    let event = SupervisorEvent::new(
        // Build the event time wrapper.
        When::new(EventTime::deterministic(
            // Set deterministic wall-clock time.
            sequence as u128,
            // Set deterministic monotonic time.
            sequence as u128,
            // Set deterministic uptime.
            sequence,
            // Set the initial child generation.
            Generation::initial(),
            // Set the first attempt.
            Attempt::first(),
            // Finish deterministic event time.
        )),
        // Build the event location.
        Where::new(SupervisorPath::root().join(&child_id.value)).with_child(child_id, child_name),
        // Attach the payload.
        what,
        // Attach the sequence.
        sequence_value,
        // Attach a deterministic correlation identifier.
        CorrelationId::from_uuid(Uuid::nil()),
        // Attach the configuration version.
        1,
        // Finish the base event envelope.
    );

    // Attach policy data when it exists.
    match policy {
        // Attach the provided policy decision.
        Some(policy) => event.with_policy(policy),
        // Return the event without policy data.
        None => event,
        // Finish policy attachment.
    }
    // Finish the deterministic event builder.
}

pub fn with_policy(self, policy: PolicyDecision) -> Self

Attaches a policy decision to an event.

Arguments

• policy: Policy decision produced for this lifecycle fact.

Returns

Returns the updated SupervisorEvent.

Examples found in repository

examples/diagnostic_replay.rs (line 238)

fn event(
    // Receive the event sequence number.
    sequence: u64,
    // Receive the child identifier.
    child_id: ChildId,
    // Receive the child display name.
    child_name: &str,
    // Receive the event payload.
    what: What,
    // Receive the optional policy decision.
    policy: Option<PolicyDecision>,
    // Return the built supervisor event.
) -> SupervisorEvent {
    // Build the event sequence value.
    let sequence_value = EventSequence::new(sequence);
    // Build the base event envelope.
    let event = SupervisorEvent::new(
        // Build the event time wrapper.
        When::new(EventTime::deterministic(
            // Set deterministic wall-clock time.
            sequence as u128,
            // Set deterministic monotonic time.
            sequence as u128,
            // Set deterministic uptime.
            sequence,
            // Set the initial child generation.
            Generation::initial(),
            // Set the first attempt.
            Attempt::first(),
            // Finish deterministic event time.
        )),
        // Build the event location.
        Where::new(SupervisorPath::root().join(&child_id.value)).with_child(child_id, child_name),
        // Attach the payload.
        what,
        // Attach the sequence.
        sequence_value,
        // Attach a deterministic correlation identifier.
        CorrelationId::from_uuid(Uuid::nil()),
        // Attach the configuration version.
        1,
        // Finish the base event envelope.
    );

    // Attach policy data when it exists.
    match policy {
        // Attach the provided policy decision.
        Some(policy) => event.with_policy(policy),
        // Return the event without policy data.
        None => event,
        // Finish policy attachment.
    }
    // Finish the deterministic event builder.
}

Trait Implementations

impl Clone for SupervisorEvent

fn clone(&self) -> SupervisorEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SupervisorEvent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SupervisorEvent

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for SupervisorEvent

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for SupervisorEvent

impl StructuralPartialEq for SupervisorEvent