Struct CorrelationKey 

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

Typed SDK identifier for CorrelationKey. Use this newtype at public boundaries instead of a raw string; constructing or cloning it is data-only and performs no side effects.

Implementations

impl CorrelationKey

pub fn new(value: impl Into<String>) -> Self

Creates a new domain::ids value with explicit caller-provided inputs. This constructor is data-only and performs no I/O or external side effects.

Panics

Panics if constructor invariants fail, such as invalid identifier text or constructor-specific bounds. Use a fallible constructor such as try_new when one is available for untrusted input.

pub fn try_new(value: impl Into<String>) -> Result<Self, IdValidationError>

Creates a new domain::ids value after validation. Returns an SDK error instead of panicking when the identifier or input does not satisfy the contract.

pub fn as_str(&self) -> &str

Returns this value as str. The accessor is side-effect free and keeps ownership with the caller.

Trait Implementations

impl Clone for CorrelationKey

fn clone(&self) -> CorrelationKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CorrelationKey

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CorrelationKey

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for CorrelationKey

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

Formats the value using the given formatter.

impl Eq for CorrelationKey

impl From<&str> for CorrelationKey

fn from(value: &str) -> Self

Converts to this type from the input type.

impl Hash for CorrelationKey

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 CorrelationKey

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

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

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

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 CorrelationKey