Struct EslEvent

Source

pub struct EslEvent { /* private fields */ }

Expand description

ESL Event structure containing headers and optional body

Implementations§

Source §

impl EslEvent

Source

pub fn new() -> Self

Create a new empty event

Source

pub fn with_type(event_type: EslEventType) -> Self

Create event with specified type

Source

pub fn event_type(&self) -> Option<EslEventType>

Parsed event type, if recognized.

Source

pub fn set_event_type(&mut self, event_type: Option<EslEventType>)

Override the event type.

Look up a header by its EventHeader enum variant (case-sensitive).

For headers not covered by EventHeader, use header_str().

Source

pub fn header_str(&self, name: &str) -> Option<&str>

Look up a header by name, trying the canonical key first then falling back through the alias map for non-canonical lookups.

Use header() with an EventHeader variant for known headers. This method is for headers not (yet) covered by the enum, such as custom X- headers or FreeSWITCH headers added after this library was published.

Source

pub fn variable_str(&self, name: &str) -> Option<&str>

Look up a channel variable by its bare name.

Equivalent to variable() but matches the HeaderLookup trait signature.

Source

pub fn headers(&self) -> &IndexMap<String, String>

All headers as a map.

Source

pub fn set_header(&mut self, name: impl Into<String>, value: impl Into<String>)

Set or overwrite a header, normalizing the key.

Source

pub fn remove_header(&mut self, name: impl AsRef<str>) -> Option<String>

Remove a header, returning its value if it existed.

Accepts both canonical and original (non-normalized) key names.

Source

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

Event body (the content after the blank line in plain-text events).

Source

pub fn set_body(&mut self, body: impl Into<String>)

Set the event body.

Source

pub fn set_priority(&mut self, priority: EslEventPriority)

Sets the priority header carried on the event.

FreeSWITCH stores this as metadata but does not use it for dispatch ordering – all events are delivered FIFO regardless of priority.

Source

pub fn push_header(&mut self, name: &str, value: &str)

Append a value to a multi-value header (PUSH semantics).

If the header doesn’t exist, sets it as a plain value. If it exists as a plain value, converts to ARRAY::old|:new. If it already has an ARRAY:: prefix, appends the new value.

let mut event = EslEvent::new();
event.push_header("X-Test", "first");
event.push_header("X-Test", "second");
assert_eq!(event.header_str("X-Test"), Some("ARRAY::first|:second"));

Source

pub fn unshift_header(&mut self, name: &str, value: &str)

Prepend a value to a multi-value header (UNSHIFT semantics).

Same conversion rules as push_header(), but inserts at the front.

let mut event = EslEvent::new();
event.set_header("X-Test", "ARRAY::b|:c");
event.unshift_header("X-Test", "a");
assert_eq!(event.header_str("X-Test"), Some("ARRAY::a|:b|:c"));

Source

pub fn is_event_type(&self, event_type: EslEventType) -> bool

Check whether this event matches the given type.

Source

pub fn to_plain_format(&self) -> String

Serialize to ESL plain text wire format with percent-encoded header values.

This is the inverse of EslParser::parse_plain_event(). The output can be fed back through the parser to reconstruct an equivalent EslEvent (round-trip).

Headers are emitted in insertion order (which matches wire order when the event was parsed from the network). Content-Length from stored headers is skipped and recomputed from the body if present.