Trait HeaderLookup

Source

pub trait HeaderLookup {
Show 23 methods    // Required methods
    fn header_str(&self, name: &str) -> Option<&str>;
    fn variable_str(&self, name: &str) -> Option<&str>;

    // Provided methods
    fn header(&self, name: EventHeader) -> Option<&str> { ... }
    fn variable(&self, name: impl VariableName) -> Option<&str> { ... }
    fn unique_id(&self) -> Option<&str> { ... }
    fn job_uuid(&self) -> Option<&str> { ... }
    fn channel_name(&self) -> Option<&str> { ... }
    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 hangup_cause(&self) -> Result<Option<HangupCause>, ParseHangupCauseError> { ... }
    fn event_subclass(&self) -> Option<&str> { ... }
    fn channel_state(
        &self,
    ) -> Result<Option<ChannelState>, ParseChannelStateError> { ... }
    fn channel_state_number(
        &self,
    ) -> Result<Option<ChannelState>, ParseChannelStateError> { ... }
    fn call_state(&self) -> Result<Option<CallState>, ParseCallStateError> { ... }
    fn answer_state(&self) -> Result<Option<AnswerState>, ParseAnswerStateError> { ... }
    fn call_direction(
        &self,
    ) -> Result<Option<CallDirection>, ParseCallDirectionError> { ... }
    fn priority(&self) -> Result<Option<EslEventPriority>, ParsePriorityError> { ... }
    fn timetable(
        &self,
        prefix: &str,
    ) -> Result<Option<ChannelTimetable>, ParseTimetableError> { ... }
    fn caller_timetable(
        &self,
    ) -> Result<Option<ChannelTimetable>, ParseTimetableError> { ... }
    fn other_leg_timetable(
        &self,
    ) -> Result<Option<ChannelTimetable>, ParseTimetableError> { ... }
}

Expand description

Trait for looking up ESL headers and channel variables from any key-value store.

Implementors provide two methods — header_str(&str) and variable_str(&str) — and get all typed accessors (channel_state(), call_direction(), timetable(), etc.) as default implementations.

This trait must be in scope (use freeswitch_types::HeaderLookup) to call its methods on EslEvent – including job_uuid(), hangup_cause(), and channel_state().

§Example

use std::collections::HashMap;
use freeswitch_types::{HeaderLookup, EventHeader, ChannelVariable};

struct MyStore(HashMap<String, String>);

impl HeaderLookup for MyStore {
    fn header_str(&self, name: &str) -> Option<&str> {
        self.0.get(name).map(|s| s.as_str())
    }
    fn variable_str(&self, name: &str) -> Option<&str> {
        self.0.get(&format!("variable_{}", name)).map(|s| s.as_str())
    }
}

let mut map = HashMap::new();
map.insert("Channel-State".into(), "CS_EXECUTE".into());
map.insert("variable_read_codec".into(), "PCMU".into());
let store = MyStore(map);

// Typed accessor from the trait (returns Result<Option<T>, E>):
assert!(store.channel_state().unwrap().is_some());

// Enum-based lookups:
assert_eq!(store.header(EventHeader::ChannelState), Some("CS_EXECUTE"));
assert_eq!(store.variable(ChannelVariable::ReadCodec), Some("PCMU"));