Skip to main content

CorrelationKey

Enum CorrelationKey 

Source
pub enum CorrelationKey {
    ActivitySequence {
        ordinal: usize,
        activity: String,
    },
    Signal {
        reference: String,
    },
    Timer {
        id: String,
    },
    Child {
        ordinal: usize,
        name: String,
    },
    ControlFlow {
        ordinal: usize,
    },
    Opaque {
        ordinal: usize,
        snippet: String,
    },
}
Expand description

The per-node identity a consumer maps recorded events onto.

The event-bearing kinds mirror how AD/AT sequences recorded events: activities by their static source position plus name, signals by name, timers by id, and children by spawn ordinal plus name. ControlFlow carries no recorded event of its own; it positions a structural node (a branch) in the discovery order. Opaque carries the source snippet of control flow the extractor could not model, so a consumer can surface it for review.

Variants§

§

ActivitySequence

An activity dispatch: its static source-order position and activity name.

Fields

§ordinal: usize

Zero-based static source-order position of this activity among all activity dispatches the extractor discovers, walking control flow depth-first from the entry function (success arms before error arms). It is a stable structural index, NOT a claim about the order replay re-applies recorded events: under branching, which activities a given run executes — and in what order — is data-dependent. A consumer aligns a recorded ActivityCompleted onto a node by the activity name and the branch the run actually took, not by assuming this ordinal equals the recorded sequence position.

§activity: String

The engine-facing activity name (the run node’s activity).

§

Signal

A signal receive, identified by the signal-reference expression text.

The signal name is not a string literal at the receive call site (it is a typed SignalRef), so the reference identifier is carried as the stable correlation token a consumer aligns against the run’s signal reference.

Fields

§reference: String

The signal-reference expression text passed to receive.

§

Timer

A timer, identified by its literal name as written at the call site.

Fields

§id: String

The timer name string literal (start_timer’s first argument).

§

Child

A child spawn: its deterministic spawn ordinal and the literal child workflow name.

Fields

§ordinal: usize

Zero-based position of this spawn among all child spawns, in call order — the ordinal a recorded child event carries.

§name: String

The child workflow name string literal (the spawn’s first argument).

§

ControlFlow

A control-flow node (a branch) that records no event of its own.

Fields

§ordinal: usize

Zero-based position of this control-flow node among all control-flow nodes, in discovery order.

§

Opaque

An unmodellable control-flow node: control flow the extractor detected but could not faithfully classify, carrying the offending source snippet so a consumer can render it for review. It records no event of its own.

Fields

§ordinal: usize

Zero-based position of this opaque node among all opaque nodes, in discovery order.

§snippet: String

The source snippet the extractor could not model.

Trait Implementations§

Source§

impl Clone for CorrelationKey

Source§

fn clone(&self) -> CorrelationKey

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for CorrelationKey

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for CorrelationKey

Source§

impl Hash for CorrelationKey

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl Ord for CorrelationKey

Source§

fn cmp(&self, other: &CorrelationKey) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 (const: unstable) · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 (const: unstable) · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 (const: unstable) · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Source§

impl PartialEq for CorrelationKey

Source§

fn eq(&self, other: &CorrelationKey) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl PartialOrd for CorrelationKey

Source§

fn partial_cmp(&self, other: &CorrelationKey) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 (const: unstable) · Source§

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 (const: unstable) · Source§

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 (const: unstable) · Source§

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 (const: unstable) · Source§

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl StructuralPartialEq for CorrelationKey

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> 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<Q, K> Comparable<K> for Q
where Q: Ord + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn compare(&self, key: &K) -> Ordering

Compare self to key and return their ordering.
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
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> Same for T

Source§

type Output = T

Should always be 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.