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

freeswitch_types/
channel.rs
