Struct EslHeaders

Source

pub struct EslHeaders { /* private fields */ }

Expand description

A flat header store that decodes FreeSWITCH ARRAY and bracket encoding when answering typed SIP header queries.

Construct with EslHeaders::new or EslHeaders::from_map. Use it anywhere a HeaderLookup or SipHeaderLookup implementor is expected:

use freeswitch_types::{EslHeaders, HeaderLookup};
use freeswitch_types::sip_header::SipHeaderLookup;

let mut h = EslHeaders::new();
h.insert("Unique-ID", "abc-123");
h.insert("Call-Info", "ARRAY::<sip:a@example.com>;purpose=icon|:<sip:b@example.com>");

assert_eq!(h.header_str("Unique-ID"), Some("abc-123"));
let ci = h.call_info().unwrap().unwrap();
assert_eq!(ci.entries().len(), 2);

HeaderLookup delegates straight to the map; SipHeaderLookup methods that parse RFC-structured values (call_info, history_info, and any future multi-value parsers) first peel the FreeSWITCH encoding and then hand pre-split entries to sip-header. Non-parsing lookups (sip_header_str, sip_header) return the raw stored value untouched — the caller sees exactly what FreeSWITCH put on the wire.

Every write normalizes its key with normalize_header_key, so a payload spelling one header two ways collapses to one entry, and every read falls back to a lowercase alias, so a query in any casing resolves. Keys containing _ are exempt from both: their suffix carries SIP wire casing.

Struct EslHeaders Copy item path

Implementations§

impl EslHeaders

pub fn new() -> Self

pub fn from_map(map: IndexMap<String, String>) -> Self

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

pub fn into_map(self) -> IndexMap<String, String>

pub fn insert(&mut self, key: impl Into<String>, value: impl Into<String>)

pub fn remove(&mut self, key: &str) -> Option<String>

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

impl EslHeaders

pub fn parse_uri_info(value: &str) -> Result<UriInfo, UriInfoError>

§Errors

§Example

pub fn split_entries(value: &str) -> Result<Vec<String>, EslArrayError>

§Errors

pub fn parse_history_info(value: &str) -> Result<HistoryInfo, HistoryInfoError>

§Errors

Trait Implementations§

impl Clone for EslHeaders

fn clone(&self) -> Self

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

impl Debug for EslHeaders

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

impl Default for EslHeaders

fn default() -> Self

impl<'de> Deserialize<'de> for EslHeaders

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

impl Eq for EslHeaders

impl<K: Into<String>, V: Into<String>> Extend<(K, V)> for EslHeaders

fn extend<I: IntoIterator<Item = (K, V)>>(&mut self, iter: I)

fn extend_one(&mut self, item: T)

fn extend_reserve(&mut self, additional: usize)

impl From<IndexMap<String, String>> for EslHeaders

fn from(map: IndexMap<String, String>) -> Self

impl<K: Into<String>, V: Into<String>> FromIterator<(K, V)> for EslHeaders

fn from_iter<I: IntoIterator<Item = (K, V)>>(iter: I) -> Self

impl HeaderLookup for EslHeaders

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

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

fn header(&self, name: EventHeader) -> Option<&str>

fn variable(&self, name: impl VariableName) -> Option<&str>

fn first_header<const N: usize>(&self, names: [EventHeader; N]) -> Option<&str>

fn unique_id(&self) -> Option<&str>

fn job_uuid(&self) -> Option<&str>

fn channel_name(&self) -> Option<&str>

fn channel_driver(&self) -> Option<&str>

fn loopback_leg(&self) -> Result<Option<LoopbackLeg>, ParseLoopbackLegError>

fn caller_id_number(&self) -> Option<&str>

fn caller_id_name(&self) -> Option<&str>

fn destination_number(&self) -> Option<&str>

fn callee_id_number(&self) -> Option<&str>

fn callee_id_name(&self) -> Option<&str>

fn channel_presence_id(&self) -> Option<&str>

fn presence_call_direction( &self, ) -> Result<Option<CallDirection>, ParseCallDirectionError>

fn event_date_timestamp(&self) -> Option<&str>

fn event_sequence(&self) -> Option<&str>

fn dtmf_duration(&self) -> Option<&str>

fn dtmf_source(&self) -> Option<&str>

fn hangup_cause(&self) -> Result<Option<HangupCause>, ParseHangupCauseError>

fn loopback_resignation(&self) -> Option<LoopbackResignation<'_>>

fn event_subclass(&self) -> Option<&str>

fn sofia_event_subclass( &self, ) -> Result<Option<SofiaEventSubclass>, ParseSofiaEventSubclassError>

fn gateway(&self) -> Option<&str>

fn profile_name(&self) -> Option<&str>

fn module_name(&self) -> Option<&str>

fn profile_uri(&self) -> Option<&str>

fn phrase(&self) -> Option<&str>

fn sip_status_code(&self) -> Result<Option<u16>, ParseIntError>

fn gateway_reg_state( &self, ) -> Result<Option<GatewayRegState>, ParseGatewayRegStateError>

fn gateway_ping_status( &self, ) -> Result<Option<GatewayPingStatus>, ParseGatewayPingStatusError>

fn sip_user_ping_status( &self, ) -> Result<Option<SipUserPingStatus>, ParseSipUserPingStatusError>

fn pl_data(&self) -> Option<&str>

fn sip_event(&self) -> Option<&str>

fn gateway_name(&self) -> Option<&str>

fn channel_state(&self) -> Result<Option<ChannelState>, ParseChannelStateError>

fn channel_state_number( &self, ) -> Result<Option<ChannelState>, ParseChannelStateError>

fn is_terminal_channel_state(&self) -> Result<bool, ParseChannelStateError>

fn call_state(&self) -> Result<Option<CallState>, ParseCallStateError>

Struct EslHeaders

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

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