Skip to main content

MessageEnvelope

Struct MessageEnvelope 

Source
pub struct MessageEnvelope<T> { /* private fields */ }
Expand description

Versioned transport-neutral message envelope.

The payload is intentionally omitted from Debug output to prevent accidental secret or PII disclosure. Delivery guarantees remain the responsibility of each native broker adapter.

Implementations§

Source§

impl<T> MessageEnvelope<T>

Source

pub fn new(name: impl Into<String>, payload: T) -> Result<Self>

Creates an envelope with a generated UUID and current UTC timestamp.

Source

pub fn from_parts( id: impl Into<String>, name: impl Into<String>, schema_version: u32, occurred_at_ms: i64, metadata: EnvelopeMetadata, payload: T, ) -> Result<Self>

Creates an envelope from explicit, validated parts.

Source

pub fn with_metadata(self, metadata: EnvelopeMetadata) -> Self

Replaces the envelope metadata.

Source

pub fn id(&self) -> &str

Returns the stable message identifier.

Source

pub fn name(&self) -> &str

Returns the stable message name.

Source

pub const fn schema_version(&self) -> u32

Returns the application schema version.

Source

pub const fn occurred_at_ms(&self) -> i64

Returns the UTC occurrence timestamp in Unix milliseconds.

Source

pub fn metadata(&self) -> &EnvelopeMetadata

Returns the envelope metadata.

Source

pub fn payload(&self) -> &T

Returns the typed payload.

Source

pub fn into_payload(self) -> T

Consumes the envelope and returns the typed payload.

Source§

impl<T> MessageEnvelope<T>
where T: Serialize,

Source

pub fn to_json(&self) -> Result<Vec<u8>>

Serializes the envelope as bounded JSON.

Source

pub fn to_json_with_limit(&self, maximum: usize) -> Result<Vec<u8>>

Serializes the envelope as JSON with an explicit byte limit.

Source§

impl<T> MessageEnvelope<T>

Source

pub fn from_json(encoded: &[u8]) -> Result<Self>

Deserializes a bounded JSON envelope.

Source

pub fn from_json_with_limit(encoded: &[u8], maximum: usize) -> Result<Self>

Deserializes JSON after enforcing an explicit inbound byte limit.

Trait Implementations§

Source§

impl<T: Clone> Clone for MessageEnvelope<T>

Source§

fn clone(&self) -> MessageEnvelope<T>

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<T> Debug for MessageEnvelope<T>

Source§

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

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

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

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<T: Eq> Eq for MessageEnvelope<T>

Source§

impl<T: PartialEq> PartialEq for MessageEnvelope<T>

Source§

fn eq(&self, other: &MessageEnvelope<T>) -> bool

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

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

Inequality operator !=. Read more
Source§

impl<T> Serialize for MessageEnvelope<T>
where T: Serialize,

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
Source§

impl<T: PartialEq> StructuralPartialEq for MessageEnvelope<T>

Auto Trait Implementations§

§

impl<T> Freeze for MessageEnvelope<T>
where T: Freeze,

§

impl<T> RefUnwindSafe for MessageEnvelope<T>
where T: RefUnwindSafe,

§

impl<T> Send for MessageEnvelope<T>
where T: Send,

§

impl<T> Sync for MessageEnvelope<T>
where T: Sync,

§

impl<T> Unpin for MessageEnvelope<T>
where T: Unpin,

§

impl<T> UnsafeUnpin for MessageEnvelope<T>
where T: UnsafeUnpin,

§

impl<T> UnwindSafe for MessageEnvelope<T>
where T: UnwindSafe,

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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