Struct OperationId 

pub struct OperationId(/* private fields */);

Correlates every event emitted by one logical operation.

An operation is one unit of lifecycle work a worker performs and can be pointed at in a log: one ask that creates and starts a trial, one resume, one finalization, one optimize run, one study open. Every event that unit emits carries the same id, which is what turns a stream of independent lifecycle records into a trace.

Invariants

• Unique within a worker, not globally. Ids come from a process-local counter that restarts at 1 every time the process does. Two workers — two threads with different WorkerIds, two processes, the same process restarted — will each hand out OperationId(1). The correlation key a downstream consumer must use is therefore the pair (worker, operation). A dashboard that groups by operation alone silently merges unrelated work from different workers, and it will look plausible while doing it.
• NONE is the reserved zero id and is never returned by next. It means “this event belongs to no operation this handle is tracking” — an honest gap, not a correlation.
• Copy and 8 bytes wide, because StudyEvent is Copy and its emit sites pass it by value.

use atune_core::telemetry::OperationId;

let first = OperationId::next();
let second = OperationId::next();
assert_ne!(first, second);
assert!(!first.is_none());
assert!(OperationId::NONE.is_none());

Implementations

impl OperationId

pub const NONE: Self

The absent operation: no operation is being tracked for this event.

Reserved, never minted. An emit site that genuinely cannot know its operation — a trial finalized by a handle that did not start it, for instance — uses this rather than minting a fresh id, because a fresh id would claim a correlation that does not exist.

pub fn next() -> Self

Mints the next process-local operation id.

Call this once at an operation boundary and carry the result through to every event the operation emits. Minting per event defeats the whole purpose: the ids would be unique and correlate nothing.

The counter wraps after 2^64 operations, which at a billion operations a second is roughly 584 years of continuous uptime; the wrapped zero is skipped so a wrapped counter can never masquerade as NONE.

pub const fn new(raw: u64) -> Self

Wraps a raw operation id — for a value that arrived over a wire.

pub const fn get(self) -> u64

Returns the raw operation id, for putting on a wire or in a field.

pub const fn is_none(self) -> bool

Whether this is the reserved NONE id.

Trait Implementations

impl Clone for OperationId

fn clone(&self) -> OperationId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for OperationId

impl Debug for OperationId

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

Formats the value using the given formatter.

impl Default for OperationId

fn default() -> OperationId

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for OperationId

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for OperationId

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

Formats the value using the given formatter.

impl Eq for OperationId

impl From<OperationId> for u64

fn from(id: OperationId) -> Self

Converts to this type from the input type.

impl From<u64> for OperationId

fn from(raw: u64) -> Self

Converts to this type from the input type.

impl Hash for OperationId

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 Ord for OperationId

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for OperationId

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for OperationId

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

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for OperationId

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for OperationId