Struct Where 

pub struct Where {
    pub supervisor_path: SupervisorPath,
    pub parent_id: Option<ChildId>,
    pub child_id: Option<ChildId>,
    pub child_name: Option<String>,
    pub tokio_task_id: Option<String>,
    pub host: Option<String>,
    pub pid: u32,
    pub thread_name: Option<String>,
    pub module_path: Option<String>,
    pub source_file: Option<String>,
    pub source_line: Option<u32>,
}

Location data attached to a supervisor event.

Fields

supervisor_path: SupervisorPath

Stable supervisor path that owns the fact.

parent_id: Option<ChildId>

Parent child identifier when the fact belongs to a nested node.

child_id: Option<ChildId>

Child identifier related to the fact.

child_name: Option<String>

Human-readable child name.

tokio_task_id: Option<String>

Tokio task identifier when it is available.

host: Option<String>

Host name reported by the runtime.

pid: u32

Process identifier that emitted the event.

thread_name: Option<String>

Current thread name when available.

module_path: Option<String>

Rust module path that emitted the event.

source_file: Option<String>

Source file that emitted the event.

source_line: Option<u32>

Source line that emitted the event.

Implementations

impl Where

pub fn new(supervisor_path: SupervisorPath) -> Self

Creates a location for a supervisor path.

Arguments

• supervisor_path: Path that owns this lifecycle fact.

Returns

Returns a Where value with process and thread defaults.

Examples

let location = rust_supervisor::event::payload::Where::new(
    rust_supervisor::id::types::SupervisorPath::root(),
);
assert_eq!(location.supervisor_path.to_string(), "/");

Examples found in repository

examples/diagnostic_replay.rs (line 223)

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_child( self, child_id: ChildId, child_name: impl Into<String>, ) -> Self

Adds child identity to the location.

Arguments

• child_id: Stable child identifier.
• child_name: Human-readable child name.

Returns

Returns the updated Where value.

Examples found in repository

examples/diagnostic_replay.rs (line 223)

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 Where

fn clone(&self) -> Where

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Where

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Where

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Where

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

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 Where

impl StructuralPartialEq for Where