Enum DisconnectReason

#[repr(i32)]
pub enum DisconnectReason {
    UnknownReason = 0,
    ClientInitiated = 1,
    DuplicateIdentity = 2,
    ServerShutdown = 3,
    ParticipantRemoved = 4,
    RoomDeleted = 5,
    StateMismatch = 6,
    JoinFailure = 7,
    Migration = 8,
    SignalClose = 9,
    RoomClosed = 10,
    UserUnavailable = 11,
    UserRejected = 12,
    SipTrunkFailure = 13,
    ConnectionTimeout = 14,
}

Variants

UnknownReason = 0

ClientInitiated = 1

the client initiated the disconnect

DuplicateIdentity = 2

another participant with the same identity has joined the room

ServerShutdown = 3

the server instance is shutting down

ParticipantRemoved = 4

RoomService.RemoveParticipant was called

RoomDeleted = 5

RoomService.DeleteRoom was called

StateMismatch = 6

the client is attempting to resume a session, but server is not aware of it

JoinFailure = 7

client was unable to connect fully

Migration = 8

Cloud-only, the server requested Participant to migrate the connection elsewhere

SignalClose = 9

the signal websocket was closed unexpectedly

RoomClosed = 10

the room was closed, due to all Standard and Ingress participants having left

UserUnavailable = 11

SIP callee did not respond in time

UserRejected = 12

SIP callee rejected the call (busy)

SipTrunkFailure = 13

SIP protocol failure or unexpected response

ConnectionTimeout = 14

server timed out a participant session

Implementations

impl DisconnectReason

pub fn is_valid(value: i32) -> bool

Returns true if value is a variant of DisconnectReason.

pub fn from_i32(value: i32) -> Option<DisconnectReason>

👎Deprecated: Use the TryFrom<i32> implementation instead

Converts an i32 to a DisconnectReason, or None if value is not a valid variant.

impl DisconnectReason

pub fn as_str_name(&self) -> &'static str

String value of the enum field names used in the ProtoBuf definition.

The values are not transformed in any way and thus are considered stable (if the ProtoBuf definition does not change) and safe for programmatic use.

pub fn from_str_name(value: &str) -> Option<Self>

Creates an enum from field names used in the ProtoBuf definition.

Trait Implementations

impl Clone for DisconnectReason

fn clone(&self) -> DisconnectReason

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DisconnectReason

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

Formats the value using the given formatter.

impl Default for DisconnectReason

fn default() -> DisconnectReason

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for DisconnectReason

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<DisconnectReason> for i32

fn from(value: DisconnectReason) -> i32

Converts to this type from the input type.

impl Hash for DisconnectReason

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 DisconnectReason

fn cmp(&self, other: &DisconnectReason) -> 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.

impl PartialEq for DisconnectReason

fn eq(&self, other: &DisconnectReason) -> 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 PartialOrd for DisconnectReason

fn partial_cmp(&self, other: &DisconnectReason) -> 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 DisconnectReason

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<i32> for DisconnectReason

type Error = DecodeError

The type returned in the event of a conversion error.

fn try_from(value: i32) -> Result<DisconnectReason, DecodeError>

Performs the conversion.

impl Copy for DisconnectReason

impl Eq for DisconnectReason

impl StructuralPartialEq for DisconnectReason