Chronicle.Correlation.CorrelationId (cratis_chronicle v1.0.1)

Copy Markdown View Source

Represents a correlation identifier for a logical operation.

Correlation IDs tie together events and side effects that belong to the same operation (for example a single HTTP request).

Summary

Types

t()

Functions

create()

Creates a new random UUIDv4 correlation id.

new(value)

Creates a new correlation id wrapper from a string value.

not_set()

Returns the sentinel value used for an explicitly unset correlation id.

Types

t()

@type t() :: %Chronicle.Correlation.CorrelationId{value: String.t()}

Functions

create()

@spec create() :: t()

Creates a new random UUIDv4 correlation id.

new(value)

@spec new(String.t()) :: t()

Creates a new correlation id wrapper from a string value.

not_set()

@spec not_set() :: t()

Returns the sentinel value used for an explicitly unset correlation id.