Struct IdempotencyKey 

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

Provider idempotency token for safe retries.

Validated on construction, empty, NUL, CR/LF, non-tab control characters, and values longer than 1 KiB are rejected. Adapters that advertise crate::Capabilities::idempotency_key forward the value verbatim to the provider’s idempotency header; the validation closes a header-injection seam at the type level.

new_unchecked is available on this type, it is declared via the @unchecked matcher arm of crate::string_newtype! so trusted-input construction (internal constants, test fixtures) stays available. End-user code should reach for Self::new / std::str::FromStr for any value that originated outside trusted code paths.

Implementations

impl IdempotencyKey

pub fn new( value: impl Into<String>, ) -> Result<IdempotencyKey, StringNewtypeError>

Construct after validating the input.

Errors

Returns $crate::StringNewtypeError if the value is empty, exceeds STRING_NEWTYPE_MAX_BYTES, or contains NUL, CR/LF, or non-tab control characters.

pub fn as_str(&self) -> &str

Borrow the validated string value.

pub fn into_inner(self) -> String

Consume the newtype and return its string value.

impl IdempotencyKey

pub fn new_unchecked(value: impl Into<String>) -> IdempotencyKey

Construct without validating.

Reserved for trusted inputs (e.g. internal constants in trusted code paths). Prefer Self::new or std::str::FromStr for any value that originated outside your own code.

This constructor exists only because the type was declared via the @unchecked matcher arm of crate::string_newtype!; the default arm omits it.

Trait Implementations

impl AsRef<str> for IdempotencyKey

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for IdempotencyKey

fn clone(&self) -> IdempotencyKey

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<(), Error>

Formats the value using the given formatter.

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

fn deserialize<D>( deserializer: D, ) -> Result<IdempotencyKey, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for IdempotencyKey

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

Formats the value using the given formatter.

impl Eq for IdempotencyKey

impl FromStr for IdempotencyKey

type Err = StringNewtypeError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<IdempotencyKey, <IdempotencyKey as FromStr>::Err>

Parses a string s to return a value of this type.

impl Hash for IdempotencyKey

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

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.

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.

impl PartialEq for IdempotencyKey

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for IdempotencyKey

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 IdempotencyKey

impl TryFrom<&str> for IdempotencyKey

type Error = StringNewtypeError

The type returned in the event of a conversion error.

fn try_from( value: &str, ) -> Result<IdempotencyKey, <IdempotencyKey as TryFrom<&str>>::Error>

Performs the conversion.

impl TryFrom<String> for IdempotencyKey

type Error = StringNewtypeError

The type returned in the event of a conversion error.

fn try_from( value: String, ) -> Result<IdempotencyKey, <IdempotencyKey as TryFrom<String>>::Error>

Performs the conversion.