Enum ChannelState 

#[non_exhaustive]
#[repr(u8)]
pub enum ChannelState {
    CsNew = 0,
    CsInit = 1,
    CsRouting = 2,
    CsSoftExecute = 3,
    CsExecute = 4,
    CsExchangeMedia = 5,
    CsPark = 6,
    CsConsumeMedia = 7,
    CsHibernate = 8,
    CsReset = 9,
    CsHangup = 10,
    CsReporting = 11,
    CsDestroy = 12,
    CsNone = 13,
}

Channel state from switch_channel_state_t – carried in the Channel-State header as a string (CS_ROUTING) and in Channel-State-Number as an integer.

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.

CsNew = 0

CsInit = 1

CsRouting = 2

CsSoftExecute = 3

CsExecute = 4

CsExchangeMedia = 5

CsPark = 6

CsConsumeMedia = 7

CsHibernate = 8

CsReset = 9

CsHangup = 10

CsReporting = 11

CsDestroy = 12

CsNone = 13

Implementations

impl ChannelState

pub const ALL: &[Self]

Every variant, in declaration order.

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

Canonical wire-format string.

impl ChannelState

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

Look up by numeric discriminant.

pub fn as_number(&self) -> u8

Numeric discriminant value.

impl ChannelState

pub fn is_terminal(&self) -> bool

Whether the channel is gone: CS_DESTROY, and nothing else.

The session’s run loop exits on CS_DESTROY; CS_NONE is a running_state sentinel the state machine aborts on if it ever reaches it, so it ends nothing despite sorting above CS_DESTROY.

CHANNEL_STATE events carry no variable_* headers, so end-of-life detected here cannot be paired with any channel variable from the same event. The variable-bearing terminal event is CHANNEL_HANGUP_COMPLETE, which is also where variable_hangup_cause first appears – CHANNEL_HANGUP carries only the Hangup-Cause header.

Trait Implementations

impl AsRef<str> for ChannelState

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for ChannelState

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ChannelState

impl Debug for ChannelState

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ChannelState

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ChannelState

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

Formats the value using the given formatter.

impl Eq for ChannelState

impl FromStr for ChannelState

type Err = ParseChannelStateError

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 ChannelState

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 Ord for ChannelState

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for ChannelState

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for ChannelState

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for ChannelState

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 ChannelState