Skip to main content

MessageExtras

Struct MessageExtras 

Source
pub struct MessageExtras {
    pub headers: Option<HashMap<String, ExtrasValue>>,
    pub ephemeral: Option<bool>,
    pub idempotency_key: Option<String>,
    pub echo: Option<bool>,
}
Expand description

Structured metadata envelope for V2-specific message features.

Present on the wire for V2 connections only. V1 connections receive messages with extras stripped entirely. Pusher SDKs ignore unknown fields so the field is safe to carry through internal pipelines even when the publisher is V1.

Fields§

§headers: Option<HashMap<String, ExtrasValue>>

Flat metadata for server-side event name filtering. Must be a flat object — no nested objects, no arrays.

§ephemeral: Option<bool>

If true: skip connection recovery buffer and webhook forwarding. Deliver to currently connected V2 subscribers only.

§idempotency_key: Option<String>

Server-side deduplication key. If the same key arrives again within the app’s idempotency TTL window, the message is silently dropped.

§echo: Option<bool>

Per-message echo control. Overrides the connection-level echo setting when explicitly set.

Implementations§

Source§

impl MessageExtras

Source

pub fn validate_headers_from_json(raw: &Value) -> Result<(), String>

Validate that headers (if present) contain only flat scalar values. This is structurally guaranteed by ExtrasValue having no Object/Array variants, but this method provides an explicit check with a clear error when validating raw JSON before deserialization.

Trait Implementations§

Source§

impl Clone for MessageExtras

Source§

fn clone(&self) -> MessageExtras

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 MessageExtras

Source§

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

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

impl Default for MessageExtras

Source§

fn default() -> MessageExtras

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

impl<'de> Deserialize<'de> for MessageExtras

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 PartialEq for MessageExtras

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for MessageExtras

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 StructuralPartialEq for MessageExtras

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

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