Skip to main content

MessageMetadata

Struct MessageMetadata 

Source
pub struct MessageMetadata { /* private fields */ }
Expand description

Metadata carried independently from a strongly typed message payload.

IDs are strings deliberately: applications may generate UUIDs, ULIDs, or another stable representation without forcing a generator into the core.

Implementations§

Source§

impl MessageMetadata

Source

pub fn new(id: impl Into<MessageId>, created_at: SystemTime) -> Self

Creates metadata using identity and time supplied by an application boundary. The core intentionally does not read the clock or generate IDs.

Source

pub fn with_correlation_id( self, correlation_id: impl Into<CorrelationId>, ) -> Self

Attaches a flow correlation identity.

Source

pub fn with_causation_id(self, causation_id: impl Into<CausationId>) -> Self

Attaches the identity of the directly causing message.

Source

pub fn with_initiated_by(self, initiated_by: impl Into<String>) -> Self

Attaches the actor or system that initiated the flow.

Source

pub fn with_source(self, source: impl Into<String>) -> Self

Attaches the logical source component.

Source

pub const fn id(&self) -> &MessageId

Returns the message identity.

Source

pub const fn created_at(&self) -> SystemTime

Returns the externally supplied creation time.

Source

pub const fn correlation_id(&self) -> Option<&CorrelationId>

Returns the optional correlation identity.

Source

pub const fn causation_id(&self) -> Option<&CausationId>

Returns the optional causation identity.

Source

pub fn initiated_by(&self) -> Option<&str>

Returns the optional initiating actor.

Source

pub fn source(&self) -> Option<&str>

Returns the optional logical source component.

Trait Implementations§

Source§

impl Clone for MessageMetadata

Source§

fn clone(&self) -> MessageMetadata

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for MessageMetadata

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for MessageMetadata

Source§

impl PartialEq for MessageMetadata

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for MessageMetadata

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.