Struct CorrelationId 

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

Correlation identifier carried end-to-end from queue to transport.

Available to adapter-specific typed options when a provider has a natural slot for it. Validated on construction with the same rules as IdempotencyKey.

new_unchecked is available, declared via the @unchecked matcher arm. See IdempotencyKey for guidance.

Implementations

impl CorrelationId

pub fn new( value: impl Into<String>, ) -> Result<CorrelationId, 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 CorrelationId

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

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 CorrelationId

fn as_ref(&self) -> &str

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

impl Clone for CorrelationId

fn clone(&self) -> CorrelationId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CorrelationId

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CorrelationId

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for CorrelationId

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

Formats the value using the given formatter.

impl Eq for CorrelationId

impl FromStr for CorrelationId

type Err = StringNewtypeError

The associated error which can be returned from parsing.

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

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

impl Hash for CorrelationId

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 CorrelationId

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 CorrelationId

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for CorrelationId

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 CorrelationId

impl TryFrom<&str> for CorrelationId

type Error = StringNewtypeError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<String> for CorrelationId

type Error = StringNewtypeError

The type returned in the event of a conversion error.

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

Performs the conversion.