Struct EventSubscription 

#[non_exhaustive]
pub struct EventSubscription { /* private fields */ }

Declarative description of an ESL event subscription.

Captures the event format, event types, custom subclasses, and filters as a single unit. Useful for config-driven subscriptions and reconnection patterns where the caller needs to rebuild subscriptions from a saved description.

Wire safety

Builder methods validate inputs against ESL wire injection risks. Custom subclasses reject \n, \r, spaces, and empty strings. Filter headers and values reject \n and \r.

Example

use freeswitch_types::{EventSubscription, EventFormat, EslEventType, EventHeader};

let sub = EventSubscription::new(EventFormat::Plain)
    .events(EslEventType::CHANNEL_EVENTS)
    .event(EslEventType::Heartbeat)
    .custom_subclass("sofia::register").unwrap()
    .filter(EventHeader::CallDirection, "inbound").unwrap();

assert!(!sub.is_empty());
assert!(!sub.is_all());

Implementations

impl EventSubscription

pub fn new(format: EventFormat) -> Self

Create an empty subscription with the given format.

pub fn all(format: EventFormat) -> Self

Create a subscription for all events.

pub fn event(self, event: EslEventType) -> Self

Add a single event type.

pub fn events<T: IntoIterator<Item = impl Borrow<EslEventType>>>( self, events: T, ) -> Self

Add multiple event types (e.g. from group constants like EslEventType::CHANNEL_EVENTS).

pub fn custom_subclass( self, subclass: impl Into<String>, ) -> Result<Self, EventSubscriptionError>

Add a custom subclass (e.g. "sofia::register").

Returns Err if the subclass contains spaces, newlines, or is empty.

pub fn custom_subclasses( self, subclasses: impl IntoIterator<Item = impl Into<String>>, ) -> Result<Self, EventSubscriptionError>

Add multiple custom subclasses.

Returns Err on the first invalid subclass.

pub fn filter( self, header: EventHeader, value: impl Into<String>, ) -> Result<Self, EventSubscriptionError>

Add a filter with a typed header.

The header enum is always valid; only the value is validated.

pub fn filter_raw( self, header: impl Into<String>, value: impl Into<String>, ) -> Result<Self, EventSubscriptionError>

Add a filter with raw header and value strings.

Both header and value are validated against newline injection.

pub fn with_format(self, format: EventFormat) -> Self

Change the event format.

pub fn format(&self) -> EventFormat

The event format.

pub fn format_mut(&mut self) -> &mut EventFormat

Mutable reference to the event format.

pub fn event_types(&self) -> &[EslEventType]

The subscribed event types.

pub fn event_types_mut(&mut self) -> &mut Vec<EslEventType>

Mutable access to the event types list.

pub fn custom_subclass_list(&self) -> &[String]

The subscribed custom subclasses.

pub fn custom_subclasses_mut(&mut self) -> &mut Vec<String>

Mutable access to the custom subclasses list.

pub fn filters(&self) -> &[(String, String)]

The event filters as (header, value) pairs.

pub fn filters_mut(&mut self) -> &mut Vec<(String, String)>

Mutable access to the filters list.

pub fn is_all(&self) -> bool

Whether the subscription includes all events.

pub fn is_empty(&self) -> bool

Whether the subscription has no events and no custom subclasses.

pub fn to_event_string(&self) -> Option<String>

Build the event string for the ESL event command.

Returns None if no events or custom subclasses are configured. Returns Some("ALL") if EslEventType::All is present. Otherwise returns space-separated event names with custom subclasses appended after a CUSTOM token.

Trait Implementations

impl Clone for EventSubscription

fn clone(&self) -> EventSubscription

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EventSubscription

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for EventSubscription

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl PartialEq for EventSubscription

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for EventSubscription

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl Eq for EventSubscription

impl StructuralPartialEq for EventSubscription