Message

Struct Message 

Source
pub struct Message {
    pub payload: Payload,
    pub headers: HashMap<String, String>,
}
Expand description

A message containing a payload and headers (metadata).

§Automatic Message ID

On construction a UUID v4 is inserted under the message_id header. While you can override this with set_header, it is discouraged—other infrastructure (logging, tracing) may rely on uniqueness.

§Correlation ID

Not created automatically to avoid overhead if unused. Call Message::ensure_correlation_id when a processor needs it. Subsequent calls return the same stable value.

§Header Semantics

All headers are simple UTF-8 strings. Keep values small; store large / complex structures in the payload or properties instead.

Fields§

§payload: Payload

The message payload.

§headers: HashMap<String, String>

Arbitrary string headers for metadata.

Implementations§

Source§

impl Message

Source

pub fn new(payload: Payload) -> Self

Creates a new message with the given payload.

Source

pub fn from_text<T: Into<String>>(s: T) -> Self

Creates a new text message.

Source

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

Returns the message body as text, if available.

Source

pub fn header(&self, key: &str) -> Option<&str>

Returns the value of a header, if present.

Source

pub fn set_header<K: Into<String>, V: Into<String>>(&mut self, k: K, v: V)

Sets a header key-value pair.

Source

pub fn ensure_correlation_id(&mut self) -> &str

Ensures a correlation id header exists; returns its value.

If a correlation_id header is present it is returned unchanged; otherwise a new UUID v4 is generated, inserted, and then returned.

§Use Cases
  • Aggregator / Splitter patterns grouping related messages.
  • Request/Reply correlation.
  • Distributed tracing boundary (can pair with trace/span ids).

Prefer calling once early (or using CorrelationInitializer) rather than sprinkling calls across processors.

Trait Implementations§

Source§

impl Clone for Message

Source§

fn clone(&self) -> Message

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Message

Source§

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

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

impl Default for Message

Source§

fn default() -> Message

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for Message

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for Message

Source§

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

Serialize this value into the given Serde serializer. Read more

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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,