Struct BatchEvent 

pub struct BatchEvent {
    pub name: String,
    pub channel: String,
    pub data: String,
    pub socket_id: Option<String>,
    pub info: Option<String>,
    pub tags: Option<HashMap<String, String>>,
    pub idempotency_key: Option<String>,
    pub extras: Option<MessageExtras>,
}

Batch event data

Fields

name: String

channel: String

data: String

socket_id: Option<String>

info: Option<String>

tags: Option<HashMap<String, String>>

idempotency_key: Option<String>

extras: Option<MessageExtras>

Implementations

impl BatchEvent

pub fn new( name: impl Into<String>, channel: impl Into<String>, data: impl Into<EventData>, ) -> Self

Creates a new batch event with EventData

pub fn with_socket_id(self, socket_id: impl Into<String>) -> Self

Sets the socket ID to exclude

pub fn with_info(self, info: impl Into<String>) -> Self

Sets the info parameter

pub fn with_tags(self, tags: HashMap<String, String>) -> Self

Sets the tags for tag filtering

pub fn with_idempotency_key(self, key: impl Into<String>) -> Self

Sets the idempotency key for deduplication

pub fn with_auto_idempotency_key(self) -> Self

Sets a randomly generated idempotency key (UUID v4)

pub fn with_extras(self, extras: MessageExtras) -> Self

Sets the V2 extras

pub fn with_ephemeral(self, ephemeral: bool) -> Self

Sets the ephemeral flag in extras

pub fn with_echo(self, echo: bool) -> Self

Sets the echo flag in extras

Trait Implementations

impl Debug for BatchEvent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BatchEvent

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for BatchEvent

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

where __S: Serializer,

Serialize this value into the given Serde serializer.