Enum HangupCause 

#[non_exhaustive]
#[repr(u16)]
pub enum HangupCause {
    None = 0,
    UnallocatedNumber = 1,
    NoRouteTransitNet = 2,
    NoRouteDestination = 3,
    ChannelUnacceptable = 6,
    CallAwardedDelivered = 7,
    NormalClearing = 16,
    UserBusy = 17,
    NoUserResponse = 18,
    NoAnswer = 19,
    SubscriberAbsent = 20,
    CallRejected = 21,
    NumberChanged = 22,
    RedirectionToNewDestination = 23,
    ExchangeRoutingError = 25,
    DestinationOutOfOrder = 27,
    InvalidNumberFormat = 28,
    FacilityRejected = 29,
    ResponseToStatusEnquiry = 30,
    NormalUnspecified = 31,
    NormalCircuitCongestion = 34,
    NetworkOutOfOrder = 38,
    NormalTemporaryFailure = 41,
    SwitchCongestion = 42,
    AccessInfoDiscarded = 43,
    RequestedChanUnavail = 44,
    PreEmpted = 45,
    FacilityNotSubscribed = 50,
    OutgoingCallBarred = 52,
    IncomingCallBarred = 54,
    BearercapabilityNotauth = 57,
    BearercapabilityNotavail = 58,
    ServiceUnavailable = 63,
    BearercapabilityNotimpl = 65,
    ChanNotImplemented = 66,
    FacilityNotImplemented = 69,
    ServiceNotImplemented = 79,
    InvalidCallReference = 81,
    IncompatibleDestination = 88,
    InvalidMsgUnspecified = 95,
    MandatoryIeMissing = 96,
    MessageTypeNonexist = 97,
    WrongMessage = 98,
    IeNonexist = 99,
    InvalidIeContents = 100,
    WrongCallState = 101,
    RecoveryOnTimerExpire = 102,
    MandatoryIeLengthError = 103,
    ProtocolError = 111,
    Interworking = 127,
    Success = 142,
    OriginatorCancel = 487,
    Crash = 700,
    SystemShutdown = 701,
    LoseRace = 702,
    ManagerRequest = 703,
    BlindTransfer = 800,
    AttendedTransfer = 801,
    AllottedTimeout = 802,
    UserChallenge = 803,
    MediaTimeout = 804,
    PickedOff = 805,
    UserNotRegistered = 806,
    ProgressTimeout = 807,
    InvalidGateway = 808,
    GatewayDown = 809,
    InvalidUrl = 810,
    InvalidProfile = 811,
    NoPickup = 812,
    SrtpReadError = 813,
    Bowout = 814,
    BusyEverywhere = 815,
    Decline = 816,
    DoesNotExistAnywhere = 817,
    NotAcceptable = 818,
    Unwanted = 819,
    NoIdentity = 820,
    BadIdentityInfo = 821,
    UnsupportedCertificate = 822,
    InvalidIdentity = 823,
    StaleDate = 824,
    RejectAll = 825,
}

Hangup cause from switch_cause_t (Q.850 + FreeSWITCH extensions).

Carried in the Hangup-Cause header. Wire format is SCREAMING_SNAKE_CASE (e.g. NORMAL_CLEARING). The numeric value matches the Q.850 cause code for standard causes, or a FreeSWITCH-internal range for extensions.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

None = 0

UnallocatedNumber = 1

NoRouteTransitNet = 2

NoRouteDestination = 3

ChannelUnacceptable = 6

CallAwardedDelivered = 7

NormalClearing = 16

UserBusy = 17

NoUserResponse = 18

NoAnswer = 19

SubscriberAbsent = 20

CallRejected = 21

NumberChanged = 22

RedirectionToNewDestination = 23

ExchangeRoutingError = 25

DestinationOutOfOrder = 27

InvalidNumberFormat = 28

FacilityRejected = 29

ResponseToStatusEnquiry = 30

NormalUnspecified = 31

NormalCircuitCongestion = 34

NetworkOutOfOrder = 38

NormalTemporaryFailure = 41

SwitchCongestion = 42

AccessInfoDiscarded = 43

RequestedChanUnavail = 44

PreEmpted = 45

FacilityNotSubscribed = 50

OutgoingCallBarred = 52

IncomingCallBarred = 54

BearercapabilityNotauth = 57

BearercapabilityNotavail = 58

ServiceUnavailable = 63

BearercapabilityNotimpl = 65

ChanNotImplemented = 66

FacilityNotImplemented = 69

ServiceNotImplemented = 79

InvalidCallReference = 81

IncompatibleDestination = 88

InvalidMsgUnspecified = 95

MandatoryIeMissing = 96

MessageTypeNonexist = 97

WrongMessage = 98

IeNonexist = 99

InvalidIeContents = 100

WrongCallState = 101

RecoveryOnTimerExpire = 102

MandatoryIeLengthError = 103

ProtocolError = 111

Interworking = 127

Success = 142

OriginatorCancel = 487

Crash = 700

SystemShutdown = 701

LoseRace = 702

ManagerRequest = 703

BlindTransfer = 800

AttendedTransfer = 801

AllottedTimeout = 802

UserChallenge = 803

MediaTimeout = 804

PickedOff = 805

UserNotRegistered = 806

ProgressTimeout = 807

InvalidGateway = 808

GatewayDown = 809

InvalidUrl = 810

InvalidProfile = 811

NoPickup = 812

SrtpReadError = 813

Bowout = 814

BusyEverywhere = 815

Decline = 816

DoesNotExistAnywhere = 817

NotAcceptable = 818

Unwanted = 819

NoIdentity = 820

BadIdentityInfo = 821

UnsupportedCertificate = 822

InvalidIdentity = 823

StaleDate = 824

Stale Date (STIR/SHAKEN).

RejectAll = 825

Reject all calls.

Implementations

impl HangupCause

pub const fn as_str(&self) -> &'static str

Canonical wire-format string.

impl HangupCause

pub fn from_number(n: u16) -> Option<Self>

Look up by numeric discriminant.

pub fn as_number(&self) -> u16

Numeric discriminant value.

impl HangupCause

pub fn from_sip_response(code: u16) -> Option<Self>

Map a SIP response code to the corresponding FreeSWITCH hangup cause.

Uses the same mapping as mod_sofia’s sofia_glue_sip_cause_to_freeswitch(). Returns None for codes without an explicit mapping.

Trait Implementations

impl Clone for HangupCause

fn clone(&self) -> HangupCause

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for HangupCause

impl Debug for HangupCause

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for HangupCause

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for HangupCause

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

Formats the value using the given formatter.

impl Eq for HangupCause

impl FromStr for HangupCause

type Err = ParseHangupCauseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for HangupCause

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for HangupCause

fn eq(&self, other: &HangupCause) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for HangupCause

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for HangupCause