Struct EffectKey 

pub struct EffectKey {
    pub name: EffectName,
    pub key: LogicalKey,
}

The unique identity of a logical effect: (name, logical key).

Stores enforce that at most one record exists per EffectKey.

Fields

name: EffectName

The effect type.

key: LogicalKey

The logical occurrence.

Implementations

impl EffectKey

pub const fn new(name: EffectName, key: LogicalKey) -> EffectKey

Pairs a name with a logical key.

pub fn idempotency_key(&self) -> IdempotencyKey

The idempotency key to forward to remote systems.

Derived deterministically (a version 5 UUID) from the name and logical key, so every attempt of the same logical effect sends the same value, even if its record is lost and recreated.

pub fn compensation_idempotency_key(&self) -> IdempotencyKey

The idempotency key for undoing the effect, distinct from Self::idempotency_key so a remote system never confuses the undo with a replay of the original request. Stable across compensation attempts, which is what makes re-running a compensation safe.

Trait Implementations

impl Clone for EffectKey

fn clone(&self) -> EffectKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EffectKey

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for EffectKey

fn deserialize<__D>( __deserializer: __D, ) -> Result<EffectKey, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for EffectKey

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

Formats the value using the given formatter.

impl Eq for EffectKey

impl Hash for EffectKey

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

where __H: Hasher,

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 EffectKey

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

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for EffectKey

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for EffectKey

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for EffectKey