freeswitch_types/
channel.rs

1//! Channel-related data types extracted from ESL event headers.
2
3use std::fmt;
4use std::str::FromStr;
5
6/// Channel state from `switch_channel_state_t` -- carried in the `Channel-State` header
7/// as a string (`CS_ROUTING`) and in `Channel-State-Number` as an integer.
8#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
9#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
10#[non_exhaustive]
11#[repr(u8)]
12#[allow(missing_docs)]
13pub enum ChannelState {
14    CsNew = 0,
15    CsInit = 1,
16    CsRouting = 2,
17    CsSoftExecute = 3,
18    CsExecute = 4,
19    CsExchangeMedia = 5,
20    CsPark = 6,
21    CsConsumeMedia = 7,
22    CsHibernate = 8,
23    CsReset = 9,
24    CsHangup = 10,
25    CsReporting = 11,
26    CsDestroy = 12,
27    CsNone = 13,
28}
29
30impl ChannelState {
31    /// Parse from the `Channel-State-Number` integer header value.
32    pub fn from_number(n: u8) -> Option<Self> {
33        match n {
34            0 => Some(Self::CsNew),
35            1 => Some(Self::CsInit),
36            2 => Some(Self::CsRouting),
37            3 => Some(Self::CsSoftExecute),
38            4 => Some(Self::CsExecute),
39            5 => Some(Self::CsExchangeMedia),
40            6 => Some(Self::CsPark),
41            7 => Some(Self::CsConsumeMedia),
42            8 => Some(Self::CsHibernate),
43            9 => Some(Self::CsReset),
44            10 => Some(Self::CsHangup),
45            11 => Some(Self::CsReporting),
46            12 => Some(Self::CsDestroy),
47            13 => Some(Self::CsNone),
48            _ => None,
49        }
50    }
51
52    /// Integer discriminant matching `switch_channel_state_t`.
53    pub fn as_number(&self) -> u8 {
54        *self as u8
55    }
56}
57
58impl fmt::Display for ChannelState {
59    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
60        let name = match self {
61            Self::CsNew => "CS_NEW",
62            Self::CsInit => "CS_INIT",
63            Self::CsRouting => "CS_ROUTING",
64            Self::CsSoftExecute => "CS_SOFT_EXECUTE",
65            Self::CsExecute => "CS_EXECUTE",
66            Self::CsExchangeMedia => "CS_EXCHANGE_MEDIA",
67            Self::CsPark => "CS_PARK",
68            Self::CsConsumeMedia => "CS_CONSUME_MEDIA",
69            Self::CsHibernate => "CS_HIBERNATE",
70            Self::CsReset => "CS_RESET",
71            Self::CsHangup => "CS_HANGUP",
72            Self::CsReporting => "CS_REPORTING",
73            Self::CsDestroy => "CS_DESTROY",
74            Self::CsNone => "CS_NONE",
75        };
76        f.write_str(name)
77    }
78}
79
80/// Error returned when parsing an invalid channel state string.
81#[derive(Debug, Clone, PartialEq, Eq)]
82pub struct ParseChannelStateError(pub String);
83
84impl fmt::Display for ParseChannelStateError {
85    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
86        write!(f, "unknown channel state: {}", self.0)
87    }
88}
89
90impl std::error::Error for ParseChannelStateError {}
91
92impl FromStr for ChannelState {
93    type Err = ParseChannelStateError;
94
95    fn from_str(s: &str) -> Result<Self, Self::Err> {
96        match s {
97            "CS_NEW" => Ok(Self::CsNew),
98            "CS_INIT" => Ok(Self::CsInit),
99            "CS_ROUTING" => Ok(Self::CsRouting),
100            "CS_SOFT_EXECUTE" => Ok(Self::CsSoftExecute),
101            "CS_EXECUTE" => Ok(Self::CsExecute),
102            "CS_EXCHANGE_MEDIA" => Ok(Self::CsExchangeMedia),
103            "CS_PARK" => Ok(Self::CsPark),
104            "CS_CONSUME_MEDIA" => Ok(Self::CsConsumeMedia),
105            "CS_HIBERNATE" => Ok(Self::CsHibernate),
106            "CS_RESET" => Ok(Self::CsReset),
107            "CS_HANGUP" => Ok(Self::CsHangup),
108            "CS_REPORTING" => Ok(Self::CsReporting),
109            "CS_DESTROY" => Ok(Self::CsDestroy),
110            "CS_NONE" => Ok(Self::CsNone),
111            _ => Err(ParseChannelStateError(s.to_string())),
112        }
113    }
114}
115
116/// Call state from `switch_channel_callstate_t` -- carried in the `Channel-Call-State` header.
117#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
118#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
119#[non_exhaustive]
120#[allow(missing_docs)]
121pub enum CallState {
122    Down,
123    Dialing,
124    Ringing,
125    Early,
126    Active,
127    Held,
128    RingWait,
129    Hangup,
130    Unheld,
131}
132
133impl fmt::Display for CallState {
134    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
135        let name = match self {
136            Self::Down => "DOWN",
137            Self::Dialing => "DIALING",
138            Self::Ringing => "RINGING",
139            Self::Early => "EARLY",
140            Self::Active => "ACTIVE",
141            Self::Held => "HELD",
142            Self::RingWait => "RING_WAIT",
143            Self::Hangup => "HANGUP",
144            Self::Unheld => "UNHELD",
145        };
146        f.write_str(name)
147    }
148}
149
150/// Error returned when parsing an invalid call state string.
151#[derive(Debug, Clone, PartialEq, Eq)]
152pub struct ParseCallStateError(pub String);
153
154impl fmt::Display for ParseCallStateError {
155    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
156        write!(f, "unknown call state: {}", self.0)
157    }
158}
159
160impl std::error::Error for ParseCallStateError {}
161
162impl FromStr for CallState {
163    type Err = ParseCallStateError;
164
165    fn from_str(s: &str) -> Result<Self, Self::Err> {
166        match s {
167            "DOWN" => Ok(Self::Down),
168            "DIALING" => Ok(Self::Dialing),
169            "RINGING" => Ok(Self::Ringing),
170            "EARLY" => Ok(Self::Early),
171            "ACTIVE" => Ok(Self::Active),
172            "HELD" => Ok(Self::Held),
173            "RING_WAIT" => Ok(Self::RingWait),
174            "HANGUP" => Ok(Self::Hangup),
175            "UNHELD" => Ok(Self::Unheld),
176            _ => Err(ParseCallStateError(s.to_string())),
177        }
178    }
179}
180
181/// Answer state from the `Answer-State` header. Wire format is lowercase.
182#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
183#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
184#[non_exhaustive]
185#[allow(missing_docs)]
186pub enum AnswerState {
187    Hangup,
188    Answered,
189    Early,
190    Ringing,
191}
192
193impl fmt::Display for AnswerState {
194    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
195        let name = match self {
196            Self::Hangup => "hangup",
197            Self::Answered => "answered",
198            Self::Early => "early",
199            Self::Ringing => "ringing",
200        };
201        f.write_str(name)
202    }
203}
204
205/// Error returned when parsing an invalid answer state string.
206#[derive(Debug, Clone, PartialEq, Eq)]
207pub struct ParseAnswerStateError(pub String);
208
209impl fmt::Display for ParseAnswerStateError {
210    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
211        write!(f, "unknown answer state: {}", self.0)
212    }
213}
214
215impl std::error::Error for ParseAnswerStateError {}
216
217impl FromStr for AnswerState {
218    type Err = ParseAnswerStateError;
219
220    fn from_str(s: &str) -> Result<Self, Self::Err> {
221        match s {
222            "hangup" => Ok(Self::Hangup),
223            "answered" => Ok(Self::Answered),
224            "early" => Ok(Self::Early),
225            "ringing" => Ok(Self::Ringing),
226            _ => Err(ParseAnswerStateError(s.to_string())),
227        }
228    }
229}
230
231/// Call direction from the `Call-Direction` header. Wire format is lowercase.
232#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
233#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
234#[non_exhaustive]
235#[allow(missing_docs)]
236pub enum CallDirection {
237    Inbound,
238    Outbound,
239}
240
241impl fmt::Display for CallDirection {
242    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
243        let name = match self {
244            Self::Inbound => "inbound",
245            Self::Outbound => "outbound",
246        };
247        f.write_str(name)
248    }
249}
250
251/// Error returned when parsing an invalid call direction string.
252#[derive(Debug, Clone, PartialEq, Eq)]
253pub struct ParseCallDirectionError(pub String);
254
255impl fmt::Display for ParseCallDirectionError {
256    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
257        write!(f, "unknown call direction: {}", self.0)
258    }
259}
260
261impl std::error::Error for ParseCallDirectionError {}
262
263impl FromStr for CallDirection {
264    type Err = ParseCallDirectionError;
265
266    fn from_str(s: &str) -> Result<Self, Self::Err> {
267        match s {
268            "inbound" => Ok(Self::Inbound),
269            "outbound" => Ok(Self::Outbound),
270            _ => Err(ParseCallDirectionError(s.to_string())),
271        }
272    }
273}
274
275/// Error returned when parsing an unknown hangup cause string.
276#[derive(Debug, Clone, PartialEq, Eq)]
277pub struct ParseHangupCauseError(pub String);
278
279impl fmt::Display for ParseHangupCauseError {
280    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
281        write!(f, "unknown hangup cause: {}", self.0)
282    }
283}
284
285impl std::error::Error for ParseHangupCauseError {}
286
287/// Hangup cause from `switch_cause_t` (Q.850 + FreeSWITCH extensions).
288///
289/// Carried in the `Hangup-Cause` header. Wire format is `SCREAMING_SNAKE_CASE`
290/// (e.g. `NORMAL_CLEARING`). The numeric value matches the Q.850 cause code
291/// for standard causes, or a FreeSWITCH-internal range for extensions.
292#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
293#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
294#[non_exhaustive]
295#[repr(u16)]
296#[allow(missing_docs)]
297pub enum HangupCause {
298    None = 0,
299    UnallocatedNumber = 1,
300    NoRouteTransitNet = 2,
301    NoRouteDestination = 3,
302    ChannelUnacceptable = 6,
303    CallAwardedDelivered = 7,
304    NormalClearing = 16,
305    UserBusy = 17,
306    NoUserResponse = 18,
307    NoAnswer = 19,
308    SubscriberAbsent = 20,
309    CallRejected = 21,
310    NumberChanged = 22,
311    RedirectionToNewDestination = 23,
312    ExchangeRoutingError = 25,
313    DestinationOutOfOrder = 27,
314    InvalidNumberFormat = 28,
315    FacilityRejected = 29,
316    ResponseToStatusEnquiry = 30,
317    NormalUnspecified = 31,
318    NormalCircuitCongestion = 34,
319    NetworkOutOfOrder = 38,
320    NormalTemporaryFailure = 41,
321    SwitchCongestion = 42,
322    AccessInfoDiscarded = 43,
323    RequestedChanUnavail = 44,
324    PreEmpted = 45,
325    FacilityNotSubscribed = 50,
326    OutgoingCallBarred = 52,
327    IncomingCallBarred = 54,
328    BearercapabilityNotauth = 57,
329    BearercapabilityNotavail = 58,
330    ServiceUnavailable = 63,
331    BearercapabilityNotimpl = 65,
332    ChanNotImplemented = 66,
333    FacilityNotImplemented = 69,
334    ServiceNotImplemented = 79,
335    InvalidCallReference = 81,
336    IncompatibleDestination = 88,
337    InvalidMsgUnspecified = 95,
338    MandatoryIeMissing = 96,
339    MessageTypeNonexist = 97,
340    WrongMessage = 98,
341    IeNonexist = 99,
342    InvalidIeContents = 100,
343    WrongCallState = 101,
344    RecoveryOnTimerExpire = 102,
345    MandatoryIeLengthError = 103,
346    ProtocolError = 111,
347    Interworking = 127,
348    Success = 142,
349    OriginatorCancel = 487,
350    Crash = 700,
351    SystemShutdown = 701,
352    LoseRace = 702,
353    ManagerRequest = 703,
354    BlindTransfer = 800,
355    AttendedTransfer = 801,
356    AllottedTimeout = 802,
357    UserChallenge = 803,
358    MediaTimeout = 804,
359    PickedOff = 805,
360    UserNotRegistered = 806,
361    ProgressTimeout = 807,
362    InvalidGateway = 808,
363    GatewayDown = 809,
364    InvalidUrl = 810,
365    InvalidProfile = 811,
366    NoPickup = 812,
367    SrtpReadError = 813,
368    Bowout = 814,
369    BusyEverywhere = 815,
370    Decline = 816,
371    DoesNotExistAnywhere = 817,
372    NotAcceptable = 818,
373    Unwanted = 819,
374    NoIdentity = 820,
375    BadIdentityInfo = 821,
376    UnsupportedCertificate = 822,
377    InvalidIdentity = 823,
378    /// Stale Date (STIR/SHAKEN).
379    StaleDate = 824,
380    /// Reject all calls.
381    RejectAll = 825,
382}
383
384impl HangupCause {
385    /// Q.850 / FreeSWITCH numeric cause code.
386    pub fn as_number(&self) -> u16 {
387        *self as u16
388    }
389
390    /// Look up by numeric cause code.
391    pub fn from_number(n: u16) -> Option<Self> {
392        match n {
393            0 => Some(Self::None),
394            1 => Some(Self::UnallocatedNumber),
395            2 => Some(Self::NoRouteTransitNet),
396            3 => Some(Self::NoRouteDestination),
397            6 => Some(Self::ChannelUnacceptable),
398            7 => Some(Self::CallAwardedDelivered),
399            16 => Some(Self::NormalClearing),
400            17 => Some(Self::UserBusy),
401            18 => Some(Self::NoUserResponse),
402            19 => Some(Self::NoAnswer),
403            20 => Some(Self::SubscriberAbsent),
404            21 => Some(Self::CallRejected),
405            22 => Some(Self::NumberChanged),
406            23 => Some(Self::RedirectionToNewDestination),
407            25 => Some(Self::ExchangeRoutingError),
408            27 => Some(Self::DestinationOutOfOrder),
409            28 => Some(Self::InvalidNumberFormat),
410            29 => Some(Self::FacilityRejected),
411            30 => Some(Self::ResponseToStatusEnquiry),
412            31 => Some(Self::NormalUnspecified),
413            34 => Some(Self::NormalCircuitCongestion),
414            38 => Some(Self::NetworkOutOfOrder),
415            41 => Some(Self::NormalTemporaryFailure),
416            42 => Some(Self::SwitchCongestion),
417            43 => Some(Self::AccessInfoDiscarded),
418            44 => Some(Self::RequestedChanUnavail),
419            45 => Some(Self::PreEmpted),
420            50 => Some(Self::FacilityNotSubscribed),
421            52 => Some(Self::OutgoingCallBarred),
422            54 => Some(Self::IncomingCallBarred),
423            57 => Some(Self::BearercapabilityNotauth),
424            58 => Some(Self::BearercapabilityNotavail),
425            63 => Some(Self::ServiceUnavailable),
426            65 => Some(Self::BearercapabilityNotimpl),
427            66 => Some(Self::ChanNotImplemented),
428            69 => Some(Self::FacilityNotImplemented),
429            79 => Some(Self::ServiceNotImplemented),
430            81 => Some(Self::InvalidCallReference),
431            88 => Some(Self::IncompatibleDestination),
432            95 => Some(Self::InvalidMsgUnspecified),
433            96 => Some(Self::MandatoryIeMissing),
434            97 => Some(Self::MessageTypeNonexist),
435            98 => Some(Self::WrongMessage),
436            99 => Some(Self::IeNonexist),
437            100 => Some(Self::InvalidIeContents),
438            101 => Some(Self::WrongCallState),
439            102 => Some(Self::RecoveryOnTimerExpire),
440            103 => Some(Self::MandatoryIeLengthError),
441            111 => Some(Self::ProtocolError),
442            127 => Some(Self::Interworking),
443            142 => Some(Self::Success),
444            487 => Some(Self::OriginatorCancel),
445            700 => Some(Self::Crash),
446            701 => Some(Self::SystemShutdown),
447            702 => Some(Self::LoseRace),
448            703 => Some(Self::ManagerRequest),
449            800 => Some(Self::BlindTransfer),
450            801 => Some(Self::AttendedTransfer),
451            802 => Some(Self::AllottedTimeout),
452            803 => Some(Self::UserChallenge),
453            804 => Some(Self::MediaTimeout),
454            805 => Some(Self::PickedOff),
455            806 => Some(Self::UserNotRegistered),
456            807 => Some(Self::ProgressTimeout),
457            808 => Some(Self::InvalidGateway),
458            809 => Some(Self::GatewayDown),
459            810 => Some(Self::InvalidUrl),
460            811 => Some(Self::InvalidProfile),
461            812 => Some(Self::NoPickup),
462            813 => Some(Self::SrtpReadError),
463            814 => Some(Self::Bowout),
464            815 => Some(Self::BusyEverywhere),
465            816 => Some(Self::Decline),
466            817 => Some(Self::DoesNotExistAnywhere),
467            818 => Some(Self::NotAcceptable),
468            819 => Some(Self::Unwanted),
469            820 => Some(Self::NoIdentity),
470            821 => Some(Self::BadIdentityInfo),
471            822 => Some(Self::UnsupportedCertificate),
472            823 => Some(Self::InvalidIdentity),
473            824 => Some(Self::StaleDate),
474            825 => Some(Self::RejectAll),
475            _ => None,
476        }
477    }
478}
479
480impl fmt::Display for HangupCause {
481    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
482        let name = match self {
483            Self::None => "NONE",
484            Self::UnallocatedNumber => "UNALLOCATED_NUMBER",
485            Self::NoRouteTransitNet => "NO_ROUTE_TRANSIT_NET",
486            Self::NoRouteDestination => "NO_ROUTE_DESTINATION",
487            Self::ChannelUnacceptable => "CHANNEL_UNACCEPTABLE",
488            Self::CallAwardedDelivered => "CALL_AWARDED_DELIVERED",
489            Self::NormalClearing => "NORMAL_CLEARING",
490            Self::UserBusy => "USER_BUSY",
491            Self::NoUserResponse => "NO_USER_RESPONSE",
492            Self::NoAnswer => "NO_ANSWER",
493            Self::SubscriberAbsent => "SUBSCRIBER_ABSENT",
494            Self::CallRejected => "CALL_REJECTED",
495            Self::NumberChanged => "NUMBER_CHANGED",
496            Self::RedirectionToNewDestination => "REDIRECTION_TO_NEW_DESTINATION",
497            Self::ExchangeRoutingError => "EXCHANGE_ROUTING_ERROR",
498            Self::DestinationOutOfOrder => "DESTINATION_OUT_OF_ORDER",
499            Self::InvalidNumberFormat => "INVALID_NUMBER_FORMAT",
500            Self::FacilityRejected => "FACILITY_REJECTED",
501            Self::ResponseToStatusEnquiry => "RESPONSE_TO_STATUS_ENQUIRY",
502            Self::NormalUnspecified => "NORMAL_UNSPECIFIED",
503            Self::NormalCircuitCongestion => "NORMAL_CIRCUIT_CONGESTION",
504            Self::NetworkOutOfOrder => "NETWORK_OUT_OF_ORDER",
505            Self::NormalTemporaryFailure => "NORMAL_TEMPORARY_FAILURE",
506            Self::SwitchCongestion => "SWITCH_CONGESTION",
507            Self::AccessInfoDiscarded => "ACCESS_INFO_DISCARDED",
508            Self::RequestedChanUnavail => "REQUESTED_CHAN_UNAVAIL",
509            Self::PreEmpted => "PRE_EMPTED",
510            Self::FacilityNotSubscribed => "FACILITY_NOT_SUBSCRIBED",
511            Self::OutgoingCallBarred => "OUTGOING_CALL_BARRED",
512            Self::IncomingCallBarred => "INCOMING_CALL_BARRED",
513            Self::BearercapabilityNotauth => "BEARERCAPABILITY_NOTAUTH",
514            Self::BearercapabilityNotavail => "BEARERCAPABILITY_NOTAVAIL",
515            Self::ServiceUnavailable => "SERVICE_UNAVAILABLE",
516            Self::BearercapabilityNotimpl => "BEARERCAPABILITY_NOTIMPL",
517            Self::ChanNotImplemented => "CHAN_NOT_IMPLEMENTED",
518            Self::FacilityNotImplemented => "FACILITY_NOT_IMPLEMENTED",
519            Self::ServiceNotImplemented => "SERVICE_NOT_IMPLEMENTED",
520            Self::InvalidCallReference => "INVALID_CALL_REFERENCE",
521            Self::IncompatibleDestination => "INCOMPATIBLE_DESTINATION",
522            Self::InvalidMsgUnspecified => "INVALID_MSG_UNSPECIFIED",
523            Self::MandatoryIeMissing => "MANDATORY_IE_MISSING",
524            Self::MessageTypeNonexist => "MESSAGE_TYPE_NONEXIST",
525            Self::WrongMessage => "WRONG_MESSAGE",
526            Self::IeNonexist => "IE_NONEXIST",
527            Self::InvalidIeContents => "INVALID_IE_CONTENTS",
528            Self::WrongCallState => "WRONG_CALL_STATE",
529            Self::RecoveryOnTimerExpire => "RECOVERY_ON_TIMER_EXPIRE",
530            Self::MandatoryIeLengthError => "MANDATORY_IE_LENGTH_ERROR",
531            Self::ProtocolError => "PROTOCOL_ERROR",
532            Self::Interworking => "INTERWORKING",
533            Self::Success => "SUCCESS",
534            Self::OriginatorCancel => "ORIGINATOR_CANCEL",
535            Self::Crash => "CRASH",
536            Self::SystemShutdown => "SYSTEM_SHUTDOWN",
537            Self::LoseRace => "LOSE_RACE",
538            Self::ManagerRequest => "MANAGER_REQUEST",
539            Self::BlindTransfer => "BLIND_TRANSFER",
540            Self::AttendedTransfer => "ATTENDED_TRANSFER",
541            Self::AllottedTimeout => "ALLOTTED_TIMEOUT",
542            Self::UserChallenge => "USER_CHALLENGE",
543            Self::MediaTimeout => "MEDIA_TIMEOUT",
544            Self::PickedOff => "PICKED_OFF",
545            Self::UserNotRegistered => "USER_NOT_REGISTERED",
546            Self::ProgressTimeout => "PROGRESS_TIMEOUT",
547            Self::InvalidGateway => "INVALID_GATEWAY",
548            Self::GatewayDown => "GATEWAY_DOWN",
549            Self::InvalidUrl => "INVALID_URL",
550            Self::InvalidProfile => "INVALID_PROFILE",
551            Self::NoPickup => "NO_PICKUP",
552            Self::SrtpReadError => "SRTP_READ_ERROR",
553            Self::Bowout => "BOWOUT",
554            Self::BusyEverywhere => "BUSY_EVERYWHERE",
555            Self::Decline => "DECLINE",
556            Self::DoesNotExistAnywhere => "DOES_NOT_EXIST_ANYWHERE",
557            Self::NotAcceptable => "NOT_ACCEPTABLE",
558            Self::Unwanted => "UNWANTED",
559            Self::NoIdentity => "NO_IDENTITY",
560            Self::BadIdentityInfo => "BAD_IDENTITY_INFO",
561            Self::UnsupportedCertificate => "UNSUPPORTED_CERTIFICATE",
562            Self::InvalidIdentity => "INVALID_IDENTITY",
563            Self::StaleDate => "STALE_DATE",
564            Self::RejectAll => "REJECT_ALL",
565        };
566        f.write_str(name)
567    }
568}
569
570impl FromStr for HangupCause {
571    type Err = ParseHangupCauseError;
572
573    fn from_str(s: &str) -> Result<Self, Self::Err> {
574        Ok(match s {
575            "NONE" => Self::None,
576            "UNALLOCATED_NUMBER" => Self::UnallocatedNumber,
577            "NO_ROUTE_TRANSIT_NET" => Self::NoRouteTransitNet,
578            "NO_ROUTE_DESTINATION" => Self::NoRouteDestination,
579            "CHANNEL_UNACCEPTABLE" => Self::ChannelUnacceptable,
580            "CALL_AWARDED_DELIVERED" => Self::CallAwardedDelivered,
581            "NORMAL_CLEARING" => Self::NormalClearing,
582            "USER_BUSY" => Self::UserBusy,
583            "NO_USER_RESPONSE" => Self::NoUserResponse,
584            "NO_ANSWER" => Self::NoAnswer,
585            "SUBSCRIBER_ABSENT" => Self::SubscriberAbsent,
586            "CALL_REJECTED" => Self::CallRejected,
587            "NUMBER_CHANGED" => Self::NumberChanged,
588            "REDIRECTION_TO_NEW_DESTINATION" => Self::RedirectionToNewDestination,
589            "EXCHANGE_ROUTING_ERROR" => Self::ExchangeRoutingError,
590            "DESTINATION_OUT_OF_ORDER" => Self::DestinationOutOfOrder,
591            "INVALID_NUMBER_FORMAT" => Self::InvalidNumberFormat,
592            "FACILITY_REJECTED" => Self::FacilityRejected,
593            "RESPONSE_TO_STATUS_ENQUIRY" => Self::ResponseToStatusEnquiry,
594            "NORMAL_UNSPECIFIED" => Self::NormalUnspecified,
595            "NORMAL_CIRCUIT_CONGESTION" => Self::NormalCircuitCongestion,
596            "NETWORK_OUT_OF_ORDER" => Self::NetworkOutOfOrder,
597            "NORMAL_TEMPORARY_FAILURE" => Self::NormalTemporaryFailure,
598            "SWITCH_CONGESTION" => Self::SwitchCongestion,
599            "ACCESS_INFO_DISCARDED" => Self::AccessInfoDiscarded,
600            "REQUESTED_CHAN_UNAVAIL" => Self::RequestedChanUnavail,
601            "PRE_EMPTED" => Self::PreEmpted,
602            "FACILITY_NOT_SUBSCRIBED" => Self::FacilityNotSubscribed,
603            "OUTGOING_CALL_BARRED" => Self::OutgoingCallBarred,
604            "INCOMING_CALL_BARRED" => Self::IncomingCallBarred,
605            "BEARERCAPABILITY_NOTAUTH" => Self::BearercapabilityNotauth,
606            "BEARERCAPABILITY_NOTAVAIL" => Self::BearercapabilityNotavail,
607            "SERVICE_UNAVAILABLE" => Self::ServiceUnavailable,
608            "BEARERCAPABILITY_NOTIMPL" => Self::BearercapabilityNotimpl,
609            "CHAN_NOT_IMPLEMENTED" => Self::ChanNotImplemented,
610            "FACILITY_NOT_IMPLEMENTED" => Self::FacilityNotImplemented,
611            "SERVICE_NOT_IMPLEMENTED" => Self::ServiceNotImplemented,
612            "INVALID_CALL_REFERENCE" => Self::InvalidCallReference,
613            "INCOMPATIBLE_DESTINATION" => Self::IncompatibleDestination,
614            "INVALID_MSG_UNSPECIFIED" => Self::InvalidMsgUnspecified,
615            "MANDATORY_IE_MISSING" => Self::MandatoryIeMissing,
616            "MESSAGE_TYPE_NONEXIST" => Self::MessageTypeNonexist,
617            "WRONG_MESSAGE" => Self::WrongMessage,
618            "IE_NONEXIST" => Self::IeNonexist,
619            "INVALID_IE_CONTENTS" => Self::InvalidIeContents,
620            "WRONG_CALL_STATE" => Self::WrongCallState,
621            "RECOVERY_ON_TIMER_EXPIRE" => Self::RecoveryOnTimerExpire,
622            "MANDATORY_IE_LENGTH_ERROR" => Self::MandatoryIeLengthError,
623            "PROTOCOL_ERROR" => Self::ProtocolError,
624            "INTERWORKING" => Self::Interworking,
625            "SUCCESS" => Self::Success,
626            "ORIGINATOR_CANCEL" => Self::OriginatorCancel,
627            "CRASH" => Self::Crash,
628            "SYSTEM_SHUTDOWN" => Self::SystemShutdown,
629            "LOSE_RACE" => Self::LoseRace,
630            "MANAGER_REQUEST" => Self::ManagerRequest,
631            "BLIND_TRANSFER" => Self::BlindTransfer,
632            "ATTENDED_TRANSFER" => Self::AttendedTransfer,
633            "ALLOTTED_TIMEOUT" => Self::AllottedTimeout,
634            "USER_CHALLENGE" => Self::UserChallenge,
635            "MEDIA_TIMEOUT" => Self::MediaTimeout,
636            "PICKED_OFF" => Self::PickedOff,
637            "USER_NOT_REGISTERED" => Self::UserNotRegistered,
638            "PROGRESS_TIMEOUT" => Self::ProgressTimeout,
639            "INVALID_GATEWAY" => Self::InvalidGateway,
640            "GATEWAY_DOWN" => Self::GatewayDown,
641            "INVALID_URL" => Self::InvalidUrl,
642            "INVALID_PROFILE" => Self::InvalidProfile,
643            "NO_PICKUP" => Self::NoPickup,
644            "SRTP_READ_ERROR" => Self::SrtpReadError,
645            "BOWOUT" => Self::Bowout,
646            "BUSY_EVERYWHERE" => Self::BusyEverywhere,
647            "DECLINE" => Self::Decline,
648            "DOES_NOT_EXIST_ANYWHERE" => Self::DoesNotExistAnywhere,
649            "NOT_ACCEPTABLE" => Self::NotAcceptable,
650            "UNWANTED" => Self::Unwanted,
651            "NO_IDENTITY" => Self::NoIdentity,
652            "BAD_IDENTITY_INFO" => Self::BadIdentityInfo,
653            "UNSUPPORTED_CERTIFICATE" => Self::UnsupportedCertificate,
654            "INVALID_IDENTITY" => Self::InvalidIdentity,
655            "STALE_DATE" => Self::StaleDate,
656            "REJECT_ALL" => Self::RejectAll,
657            _ => return Err(ParseHangupCauseError(s.to_string())),
658        })
659    }
660}
661
662/// Channel timing data from FreeSWITCH's `switch_channel_timetable_t`.
663///
664/// Timestamps are epoch microseconds (`i64`). A value of `0` means the
665/// corresponding event never occurred (e.g., `hungup == Some(0)` means
666/// the channel has not hung up yet). `None` means the header was absent
667/// or unparseable.
668///
669/// Extracted from ESL event headers using a prefix (typically `"Caller"`
670/// or `"Other-Leg"`). The wire header format is `{prefix}-{suffix}`,
671/// e.g. `Caller-Channel-Created-Time`.
672#[derive(Debug, Clone, Copy, PartialEq, Eq, Default)]
673#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
674#[non_exhaustive]
675pub struct ChannelTimetable {
676    /// When the caller profile was created.
677    pub profile_created: Option<i64>,
678    /// When the channel was created.
679    pub created: Option<i64>,
680    /// When the channel was answered.
681    pub answered: Option<i64>,
682    /// When early media (183) was received.
683    pub progress: Option<i64>,
684    /// When media-bearing early media arrived.
685    pub progress_media: Option<i64>,
686    /// When the channel hung up.
687    pub hungup: Option<i64>,
688    /// When the channel was transferred.
689    pub transferred: Option<i64>,
690    /// When the channel was resurrected.
691    pub resurrected: Option<i64>,
692    /// When the channel was bridged.
693    pub bridged: Option<i64>,
694    /// Timestamp of the last hold event.
695    pub last_hold: Option<i64>,
696    /// Accumulated hold time in microseconds.
697    pub hold_accum: Option<i64>,
698}
699
700/// Header prefix identifying which call leg's timetable to extract.
701///
702/// FreeSWITCH emits timetable headers as `{prefix}-Channel-Created-Time`, etc.
703/// The prefix varies by context -- `Caller` for the primary leg, `Other-Leg`
704/// for the bridged party, `Channel` in outbound ESL mode, etc.
705#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
706#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
707#[non_exhaustive]
708pub enum TimetablePrefix {
709    /// Primary call leg (`Caller-*`).
710    Caller,
711    /// Bridged party (`Other-Leg-*`).
712    OtherLeg,
713    /// Outbound ESL channel profile (`Channel-*`).
714    Channel,
715    /// XML dialplan hunt (`Hunt-*`).
716    Hunt,
717    /// Bridge debug originator (`ORIGINATOR-*`).
718    Originator,
719    /// Bridge debug originatee (`ORIGINATEE-*`).
720    Originatee,
721    /// Post-bridge debug originator (`POST-ORIGINATOR-*`).
722    PostOriginator,
723    /// Post-bridge debug originatee (`POST-ORIGINATEE-*`).
724    PostOriginatee,
725}
726
727impl TimetablePrefix {
728    /// Wire-format prefix string.
729    pub fn as_str(&self) -> &'static str {
730        match self {
731            Self::Caller => "Caller",
732            Self::OtherLeg => "Other-Leg",
733            Self::Channel => "Channel",
734            Self::Hunt => "Hunt",
735            Self::Originator => "ORIGINATOR",
736            Self::Originatee => "ORIGINATEE",
737            Self::PostOriginator => "POST-ORIGINATOR",
738            Self::PostOriginatee => "POST-ORIGINATEE",
739        }
740    }
741}
742
743impl fmt::Display for TimetablePrefix {
744    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
745        f.write_str(self.as_str())
746    }
747}
748
749impl AsRef<str> for TimetablePrefix {
750    fn as_ref(&self) -> &str {
751        self.as_str()
752    }
753}
754
755/// Error returned when a timetable header is present but not a valid `i64`.
756#[derive(Debug, Clone, PartialEq, Eq)]
757#[non_exhaustive]
758pub struct ParseTimetableError {
759    /// Full header name (e.g. `Caller-Channel-Created-Time`).
760    pub header: String,
761    /// The unparseable value found in the header.
762    pub value: String,
763}
764
765impl fmt::Display for ParseTimetableError {
766    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
767        write!(
768            f,
769            "invalid timetable value for {}: {:?}",
770            self.header, self.value
771        )
772    }
773}
774
775impl std::error::Error for ParseTimetableError {}
776
777impl ParseTimetableError {
778    /// Create a new timetable parse error.
779    pub fn new(header: impl Into<String>, value: impl Into<String>) -> Self {
780        Self {
781            header: header.into(),
782            value: value.into(),
783        }
784    }
785}
786
787impl ChannelTimetable {
788    /// Extract a timetable by looking up prefixed header names via a closure.
789    ///
790    /// The closure receives full header names (e.g. `"Caller-Channel-Created-Time"`)
791    /// and should return the raw value if present. Works with any key-value store:
792    /// `HashMap<String, String>`, `EslEvent`, `BTreeMap`, etc.
793    ///
794    /// Returns `Ok(None)` if no timestamp headers with this prefix are present.
795    /// Returns `Err` if a header is present but contains an invalid (non-`i64`) value.
796    ///
797    /// ```
798    /// use std::collections::HashMap;
799    /// use freeswitch_types::{ChannelTimetable, TimetablePrefix};
800    ///
801    /// let mut headers: HashMap<String, String> = HashMap::new();
802    /// headers.insert("Caller-Channel-Created-Time".into(), "1700000001000000".into());
803    ///
804    /// // With enum:
805    /// let tt = ChannelTimetable::from_lookup(TimetablePrefix::Caller, |k| headers.get(k).map(|v: &String| v.as_str()));
806    /// assert!(tt.unwrap().unwrap().created.is_some());
807    ///
808    /// // With raw string (e.g. for dynamic "Call-1" prefix):
809    /// let tt = ChannelTimetable::from_lookup("Caller", |k| headers.get(k).map(|v: &String| v.as_str()));
810    /// assert!(tt.unwrap().unwrap().created.is_some());
811    /// ```
812    pub fn from_lookup<'a>(
813        prefix: impl AsRef<str>,
814        lookup: impl Fn(&str) -> Option<&'a str>,
815    ) -> Result<Option<Self>, ParseTimetableError> {
816        let prefix = prefix.as_ref();
817        let mut tt = Self::default();
818        let mut found = false;
819
820        macro_rules! field {
821            ($field:ident, $suffix:literal) => {
822                let header = format!("{}-{}", prefix, $suffix);
823                if let Some(raw) = lookup(&header) {
824                    let v: i64 = raw
825                        .parse()
826                        .map_err(|_| ParseTimetableError {
827                            header: header.clone(),
828                            value: raw.to_string(),
829                        })?;
830                    tt.$field = Some(v);
831                    found = true;
832                }
833            };
834        }
835
836        field!(profile_created, "Profile-Created-Time");
837        field!(created, "Channel-Created-Time");
838        field!(answered, "Channel-Answered-Time");
839        field!(progress, "Channel-Progress-Time");
840        field!(progress_media, "Channel-Progress-Media-Time");
841        field!(hungup, "Channel-Hangup-Time");
842        field!(transferred, "Channel-Transfer-Time");
843        field!(resurrected, "Channel-Resurrect-Time");
844        field!(bridged, "Channel-Bridged-Time");
845        field!(last_hold, "Channel-Last-Hold");
846        field!(hold_accum, "Channel-Hold-Accum");
847
848        if found {
849            Ok(Some(tt))
850        } else {
851            Ok(None)
852        }
853    }
854}
855
856#[cfg(test)]
857mod tests {
858    use super::*;
859    use crate::event::EslEvent;
860    use crate::lookup::HeaderLookup;
861
862    // --- ChannelState tests ---
863
864    #[test]
865    fn test_channel_state_display() {
866        assert_eq!(ChannelState::CsNew.to_string(), "CS_NEW");
867        assert_eq!(ChannelState::CsInit.to_string(), "CS_INIT");
868        assert_eq!(ChannelState::CsRouting.to_string(), "CS_ROUTING");
869        assert_eq!(ChannelState::CsSoftExecute.to_string(), "CS_SOFT_EXECUTE");
870        assert_eq!(ChannelState::CsExecute.to_string(), "CS_EXECUTE");
871        assert_eq!(
872            ChannelState::CsExchangeMedia.to_string(),
873            "CS_EXCHANGE_MEDIA"
874        );
875        assert_eq!(ChannelState::CsPark.to_string(), "CS_PARK");
876        assert_eq!(ChannelState::CsConsumeMedia.to_string(), "CS_CONSUME_MEDIA");
877        assert_eq!(ChannelState::CsHibernate.to_string(), "CS_HIBERNATE");
878        assert_eq!(ChannelState::CsReset.to_string(), "CS_RESET");
879        assert_eq!(ChannelState::CsHangup.to_string(), "CS_HANGUP");
880        assert_eq!(ChannelState::CsReporting.to_string(), "CS_REPORTING");
881        assert_eq!(ChannelState::CsDestroy.to_string(), "CS_DESTROY");
882        assert_eq!(ChannelState::CsNone.to_string(), "CS_NONE");
883    }
884
885    #[test]
886    fn test_channel_state_from_str() {
887        assert_eq!("CS_NEW".parse::<ChannelState>(), Ok(ChannelState::CsNew));
888        assert_eq!(
889            "CS_EXECUTE".parse::<ChannelState>(),
890            Ok(ChannelState::CsExecute)
891        );
892        assert_eq!(
893            "CS_HANGUP".parse::<ChannelState>(),
894            Ok(ChannelState::CsHangup)
895        );
896        assert_eq!(
897            "CS_DESTROY".parse::<ChannelState>(),
898            Ok(ChannelState::CsDestroy)
899        );
900    }
901
902    #[test]
903    fn test_channel_state_from_str_rejects_wrong_case() {
904        assert!("cs_new"
905            .parse::<ChannelState>()
906            .is_err());
907        assert!("Cs_Routing"
908            .parse::<ChannelState>()
909            .is_err());
910    }
911
912    #[test]
913    fn test_channel_state_from_str_unknown() {
914        assert!("CS_BOGUS"
915            .parse::<ChannelState>()
916            .is_err());
917        assert!(""
918            .parse::<ChannelState>()
919            .is_err());
920    }
921
922    #[test]
923    fn test_channel_state_from_number() {
924        assert_eq!(ChannelState::from_number(0), Some(ChannelState::CsNew));
925        assert_eq!(ChannelState::from_number(4), Some(ChannelState::CsExecute));
926        assert_eq!(ChannelState::from_number(10), Some(ChannelState::CsHangup));
927        assert_eq!(ChannelState::from_number(13), Some(ChannelState::CsNone));
928        assert_eq!(ChannelState::from_number(14), None);
929        assert_eq!(ChannelState::from_number(255), None);
930    }
931
932    #[test]
933    fn test_channel_state_as_number() {
934        assert_eq!(ChannelState::CsNew.as_number(), 0);
935        assert_eq!(ChannelState::CsExecute.as_number(), 4);
936        assert_eq!(ChannelState::CsHangup.as_number(), 10);
937        assert_eq!(ChannelState::CsNone.as_number(), 13);
938    }
939
940    #[test]
941    fn channel_state_ordering_follows_lifecycle() {
942        assert!(ChannelState::CsNew < ChannelState::CsInit);
943        assert!(ChannelState::CsInit < ChannelState::CsRouting);
944        assert!(ChannelState::CsRouting < ChannelState::CsExecute);
945        assert!(ChannelState::CsExecute < ChannelState::CsHangup);
946        assert!(ChannelState::CsHangup < ChannelState::CsReporting);
947        assert!(ChannelState::CsReporting < ChannelState::CsDestroy);
948    }
949
950    // Negated >= reads as "not yet in teardown", which is the real consumer intent.
951    #[allow(clippy::nonminimal_bool)]
952    #[test]
953    fn channel_state_teardown_check() {
954        assert!(ChannelState::CsHangup >= ChannelState::CsHangup);
955        assert!(ChannelState::CsReporting >= ChannelState::CsHangup);
956        assert!(ChannelState::CsDestroy >= ChannelState::CsHangup);
957        assert!(!(ChannelState::CsExecute >= ChannelState::CsHangup));
958        assert!(!(ChannelState::CsPark >= ChannelState::CsHangup));
959    }
960
961    // --- CallState tests ---
962
963    #[test]
964    fn call_state_ordering_matches_c_enum() {
965        assert!(CallState::Down < CallState::Dialing);
966        assert!(CallState::Dialing < CallState::Ringing);
967        assert!(CallState::Early < CallState::Active);
968        assert!(CallState::Active < CallState::Hangup);
969    }
970
971    #[test]
972    fn test_call_state_display() {
973        assert_eq!(CallState::Down.to_string(), "DOWN");
974        assert_eq!(CallState::Dialing.to_string(), "DIALING");
975        assert_eq!(CallState::Ringing.to_string(), "RINGING");
976        assert_eq!(CallState::Early.to_string(), "EARLY");
977        assert_eq!(CallState::Active.to_string(), "ACTIVE");
978        assert_eq!(CallState::Held.to_string(), "HELD");
979        assert_eq!(CallState::RingWait.to_string(), "RING_WAIT");
980        assert_eq!(CallState::Hangup.to_string(), "HANGUP");
981        assert_eq!(CallState::Unheld.to_string(), "UNHELD");
982    }
983
984    #[test]
985    fn test_call_state_from_str() {
986        assert_eq!("DOWN".parse::<CallState>(), Ok(CallState::Down));
987        assert_eq!("ACTIVE".parse::<CallState>(), Ok(CallState::Active));
988        assert_eq!("RING_WAIT".parse::<CallState>(), Ok(CallState::RingWait));
989        assert_eq!("UNHELD".parse::<CallState>(), Ok(CallState::Unheld));
990    }
991
992    #[test]
993    fn test_call_state_from_str_rejects_wrong_case() {
994        assert!("down"
995            .parse::<CallState>()
996            .is_err());
997        assert!("Active"
998            .parse::<CallState>()
999            .is_err());
1000    }
1001
1002    #[test]
1003    fn test_call_state_from_str_unknown() {
1004        assert!("BOGUS"
1005            .parse::<CallState>()
1006            .is_err());
1007    }
1008
1009    // --- AnswerState tests ---
1010
1011    #[test]
1012    fn test_answer_state_display() {
1013        assert_eq!(AnswerState::Hangup.to_string(), "hangup");
1014        assert_eq!(AnswerState::Answered.to_string(), "answered");
1015        assert_eq!(AnswerState::Early.to_string(), "early");
1016        assert_eq!(AnswerState::Ringing.to_string(), "ringing");
1017    }
1018
1019    #[test]
1020    fn test_answer_state_from_str() {
1021        assert_eq!("hangup".parse::<AnswerState>(), Ok(AnswerState::Hangup));
1022        assert_eq!("answered".parse::<AnswerState>(), Ok(AnswerState::Answered));
1023        assert_eq!("early".parse::<AnswerState>(), Ok(AnswerState::Early));
1024        assert_eq!("ringing".parse::<AnswerState>(), Ok(AnswerState::Ringing));
1025    }
1026
1027    #[test]
1028    fn test_answer_state_from_str_rejects_wrong_case() {
1029        assert!("HANGUP"
1030            .parse::<AnswerState>()
1031            .is_err());
1032        assert!("Answered"
1033            .parse::<AnswerState>()
1034            .is_err());
1035    }
1036
1037    #[test]
1038    fn test_answer_state_from_str_unknown() {
1039        assert!("bogus"
1040            .parse::<AnswerState>()
1041            .is_err());
1042    }
1043
1044    // --- CallDirection tests ---
1045
1046    #[test]
1047    fn test_call_direction_display() {
1048        assert_eq!(CallDirection::Inbound.to_string(), "inbound");
1049        assert_eq!(CallDirection::Outbound.to_string(), "outbound");
1050    }
1051
1052    #[test]
1053    fn test_call_direction_from_str() {
1054        assert_eq!(
1055            "inbound".parse::<CallDirection>(),
1056            Ok(CallDirection::Inbound)
1057        );
1058        assert_eq!(
1059            "outbound".parse::<CallDirection>(),
1060            Ok(CallDirection::Outbound)
1061        );
1062    }
1063
1064    #[test]
1065    fn test_call_direction_from_str_rejects_wrong_case() {
1066        assert!("INBOUND"
1067            .parse::<CallDirection>()
1068            .is_err());
1069        assert!("Outbound"
1070            .parse::<CallDirection>()
1071            .is_err());
1072    }
1073
1074    #[test]
1075    fn test_call_direction_from_str_unknown() {
1076        assert!("bogus"
1077            .parse::<CallDirection>()
1078            .is_err());
1079    }
1080
1081    // --- HangupCause tests ---
1082
1083    #[test]
1084    fn hangup_cause_display() {
1085        assert_eq!(HangupCause::NormalClearing.to_string(), "NORMAL_CLEARING");
1086        assert_eq!(HangupCause::UserBusy.to_string(), "USER_BUSY");
1087        assert_eq!(
1088            HangupCause::OriginatorCancel.to_string(),
1089            "ORIGINATOR_CANCEL"
1090        );
1091        assert_eq!(HangupCause::None.to_string(), "NONE");
1092    }
1093
1094    #[test]
1095    fn hangup_cause_from_str() {
1096        assert_eq!(
1097            "NORMAL_CLEARING"
1098                .parse::<HangupCause>()
1099                .unwrap(),
1100            HangupCause::NormalClearing
1101        );
1102        assert_eq!(
1103            "USER_BUSY"
1104                .parse::<HangupCause>()
1105                .unwrap(),
1106            HangupCause::UserBusy
1107        );
1108    }
1109
1110    #[test]
1111    fn hangup_cause_from_str_rejects_wrong_case() {
1112        assert!("normal_clearing"
1113            .parse::<HangupCause>()
1114            .is_err());
1115        assert!("User_Busy"
1116            .parse::<HangupCause>()
1117            .is_err());
1118    }
1119
1120    #[test]
1121    fn hangup_cause_from_str_unknown() {
1122        assert!("BOGUS_CAUSE"
1123            .parse::<HangupCause>()
1124            .is_err());
1125    }
1126
1127    #[test]
1128    fn hangup_cause_display_round_trip() {
1129        let causes = [
1130            HangupCause::None,
1131            HangupCause::NormalClearing,
1132            HangupCause::UserBusy,
1133            HangupCause::NoAnswer,
1134            HangupCause::OriginatorCancel,
1135            HangupCause::BlindTransfer,
1136            HangupCause::InvalidIdentity,
1137        ];
1138        for cause in causes {
1139            let s = cause.to_string();
1140            let parsed: HangupCause = s
1141                .parse()
1142                .unwrap();
1143            assert_eq!(parsed, cause);
1144        }
1145    }
1146
1147    #[test]
1148    fn hangup_cause_as_number_q850() {
1149        assert_eq!(HangupCause::None.as_number(), 0);
1150        assert_eq!(HangupCause::UnallocatedNumber.as_number(), 1);
1151        assert_eq!(HangupCause::NormalClearing.as_number(), 16);
1152        assert_eq!(HangupCause::UserBusy.as_number(), 17);
1153        assert_eq!(HangupCause::NoAnswer.as_number(), 19);
1154        assert_eq!(HangupCause::CallRejected.as_number(), 21);
1155        assert_eq!(HangupCause::NormalUnspecified.as_number(), 31);
1156        assert_eq!(HangupCause::Interworking.as_number(), 127);
1157    }
1158
1159    #[test]
1160    fn hangup_cause_as_number_freeswitch_extensions() {
1161        assert_eq!(HangupCause::Success.as_number(), 142);
1162        assert_eq!(HangupCause::OriginatorCancel.as_number(), 487);
1163        assert_eq!(HangupCause::Crash.as_number(), 700);
1164        assert_eq!(HangupCause::BlindTransfer.as_number(), 800);
1165        assert_eq!(HangupCause::InvalidIdentity.as_number(), 823);
1166    }
1167
1168    #[test]
1169    fn hangup_cause_from_number_round_trip() {
1170        let codes: &[u16] = &[0, 1, 16, 17, 19, 21, 31, 127, 142, 487, 700, 800, 823];
1171        for &code in codes {
1172            let cause = HangupCause::from_number(code).unwrap();
1173            assert_eq!(cause.as_number(), code);
1174        }
1175    }
1176
1177    #[test]
1178    fn hangup_cause_from_number_unknown() {
1179        assert!(HangupCause::from_number(999).is_none());
1180        assert!(HangupCause::from_number(4).is_none());
1181    }
1182
1183    // --- ChannelTimetable tests ---
1184
1185    #[test]
1186    fn caller_timetable_all_fields() {
1187        let mut event = EslEvent::new();
1188        event.set_header("Caller-Profile-Created-Time", "1700000000000000");
1189        event.set_header("Caller-Channel-Created-Time", "1700000001000000");
1190        event.set_header("Caller-Channel-Answered-Time", "1700000005000000");
1191        event.set_header("Caller-Channel-Progress-Time", "1700000002000000");
1192        event.set_header("Caller-Channel-Progress-Media-Time", "1700000003000000");
1193        event.set_header("Caller-Channel-Hangup-Time", "0");
1194        event.set_header("Caller-Channel-Transfer-Time", "0");
1195        event.set_header("Caller-Channel-Resurrect-Time", "0");
1196        event.set_header("Caller-Channel-Bridged-Time", "1700000006000000");
1197        event.set_header("Caller-Channel-Last-Hold", "0");
1198        event.set_header("Caller-Channel-Hold-Accum", "0");
1199
1200        let tt = event
1201            .caller_timetable()
1202            .unwrap()
1203            .expect("should have timetable");
1204        assert_eq!(tt.profile_created, Some(1700000000000000));
1205        assert_eq!(tt.created, Some(1700000001000000));
1206        assert_eq!(tt.answered, Some(1700000005000000));
1207        assert_eq!(tt.progress, Some(1700000002000000));
1208        assert_eq!(tt.progress_media, Some(1700000003000000));
1209        assert_eq!(tt.hungup, Some(0));
1210        assert_eq!(tt.transferred, Some(0));
1211        assert_eq!(tt.resurrected, Some(0));
1212        assert_eq!(tt.bridged, Some(1700000006000000));
1213        assert_eq!(tt.last_hold, Some(0));
1214        assert_eq!(tt.hold_accum, Some(0));
1215    }
1216
1217    #[test]
1218    fn other_leg_timetable() {
1219        let mut event = EslEvent::new();
1220        event.set_header("Other-Leg-Profile-Created-Time", "1700000000000000");
1221        event.set_header("Other-Leg-Channel-Created-Time", "1700000001000000");
1222        event.set_header("Other-Leg-Channel-Answered-Time", "1700000005000000");
1223        event.set_header("Other-Leg-Channel-Progress-Time", "0");
1224        event.set_header("Other-Leg-Channel-Progress-Media-Time", "0");
1225        event.set_header("Other-Leg-Channel-Hangup-Time", "0");
1226        event.set_header("Other-Leg-Channel-Transfer-Time", "0");
1227        event.set_header("Other-Leg-Channel-Resurrect-Time", "0");
1228        event.set_header("Other-Leg-Channel-Bridged-Time", "1700000006000000");
1229        event.set_header("Other-Leg-Channel-Last-Hold", "0");
1230        event.set_header("Other-Leg-Channel-Hold-Accum", "0");
1231
1232        let tt = event
1233            .other_leg_timetable()
1234            .unwrap()
1235            .expect("should have timetable");
1236        assert_eq!(tt.created, Some(1700000001000000));
1237        assert_eq!(tt.bridged, Some(1700000006000000));
1238    }
1239
1240    #[test]
1241    fn timetable_no_headers() {
1242        let event = EslEvent::new();
1243        assert_eq!(
1244            event
1245                .caller_timetable()
1246                .unwrap(),
1247            None
1248        );
1249        assert_eq!(
1250            event
1251                .other_leg_timetable()
1252                .unwrap(),
1253            None
1254        );
1255    }
1256
1257    #[test]
1258    fn timetable_partial_headers() {
1259        let mut event = EslEvent::new();
1260        event.set_header("Caller-Channel-Created-Time", "1700000001000000");
1261
1262        let tt = event
1263            .caller_timetable()
1264            .unwrap()
1265            .expect("at least one field parsed");
1266        assert_eq!(tt.created, Some(1700000001000000));
1267        assert_eq!(tt.answered, None);
1268        assert_eq!(tt.profile_created, None);
1269    }
1270
1271    #[test]
1272    fn timetable_invalid_value_is_error() {
1273        let mut event = EslEvent::new();
1274        event.set_header("Caller-Channel-Created-Time", "not_a_number");
1275
1276        let err = event
1277            .caller_timetable()
1278            .unwrap_err();
1279        assert_eq!(err.header, "Caller-Channel-Created-Time");
1280        assert_eq!(err.value, "not_a_number");
1281    }
1282
1283    #[test]
1284    fn timetable_valid_then_invalid_is_error() {
1285        let mut event = EslEvent::new();
1286        event.set_header("Caller-Profile-Created-Time", "1700000000000000");
1287        event.set_header("Caller-Channel-Created-Time", "garbage");
1288
1289        let err = event
1290            .caller_timetable()
1291            .unwrap_err();
1292        assert_eq!(err.header, "Caller-Channel-Created-Time");
1293        assert_eq!(err.value, "garbage");
1294    }
1295
1296    #[test]
1297    fn timetable_zero_preserved() {
1298        let mut event = EslEvent::new();
1299        event.set_header("Caller-Channel-Hangup-Time", "0");
1300
1301        let tt = event
1302            .caller_timetable()
1303            .unwrap()
1304            .expect("should have timetable");
1305        assert_eq!(tt.hungup, Some(0));
1306    }
1307
1308    #[test]
1309    fn timetable_custom_prefix() {
1310        let mut event = EslEvent::new();
1311        event.set_header("Channel-Channel-Created-Time", "1700000001000000");
1312
1313        let tt = event
1314            .timetable("Channel")
1315            .unwrap()
1316            .expect("custom prefix should work");
1317        assert_eq!(tt.created, Some(1700000001000000));
1318    }
1319}
freeswitch_types/channel.rs

freeswitch_types/
channel.rs
