Struct IdempotencyKey 

pub struct IdempotencyKey(pub String);

Stable idempotency key of a command (I14).

Tuple Fields

0: String

Implementations

impl IdempotencyKey

pub fn derive( account: &AccountId, turn_id: &TurnId, case_ref: &CaseRef, origin: &CommandOrigin, command: &Value, ) -> Result<Self, HashError>

Derives the key as blake3(canonical_json({domain, account, turn_id, case_ref, origin, command})).

The key is stable for the same inputs across processes and library versions that share the domain prefix. It changes when any input changes, including the expected revision inside case_ref: a command re-planned against a newer revision is a new command, while a crash-recovery replay of the same turn reproduces the same key.

Examples

use turnframe_core::prelude::*;
use serde_json::json;

let account = AccountId::from("acct");
let turn = TurnId::nil();
let case_ref = CaseRef::new("trip", "i1", CaseRevision(3));
let origin = CommandOrigin::DirectSafeUserAct {
    evidence_digest: Digest::of_bytes(b"evidence"),
};
let command = json!({ "set_name": { "value": "Lisbon" } });
let key = IdempotencyKey::derive(&account, &turn, &case_ref, &origin, &command)?;
// The same turn replayed after a crash derives the same key ...
assert_eq!(
    key,
    IdempotencyKey::derive(&account, &turn, &case_ref, &origin, &command)?
);
// ... but a command planned against a newer revision is a new command.
let newer = case_ref.with_revision(CaseRevision(4));
assert_ne!(
    key,
    IdempotencyKey::derive(&account, &turn, &newer, &origin, &command)?
);

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

Wraps an externally supplied key (e.g. from a callback).

pub fn as_str(&self) -> &str

Borrows the key.

Trait Implementations

impl Clone for IdempotencyKey

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IdempotencyKey

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for IdempotencyKey

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for IdempotencyKey

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

Formats the value using the given formatter.

impl Eq for IdempotencyKey

impl Hash for IdempotencyKey

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 JsonSchema for IdempotencyKey

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Ord for IdempotencyKey

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

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for IdempotencyKey

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

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 IdempotencyKey