Struct ErrorCode

pub struct ErrorCode { /* private fields */ }

The ErrorCode Attribute

Implementations

impl ErrorCode

pub const TRY_ALTERNATE: u16 = 301u16

Try an alternate server. The AlternateServer or AlternateDomain contains the location of where to forward this request.

pub const BAD_REQUEST: u16 = 400u16

The request was malformed and could not be processed.

pub const UNAUTHORIZED: u16 = 401u16

The required credentials were not found or did not match.

pub const FORBIDDEN: u16 = 403u16

Not allowed to access this resource.

pub const UNKNOWN_ATTRIBUTE: u16 = 420u16

An unknown comprehension required attribute was present. The UnknownAttributes contains the specific attribute/s.

pub const ALLOCATION_MISMATCH: u16 = 437u16

The allocation already exists on this server.

pub const STALE_NONCE: u16 = 438u16

The nonce is no longer valid.

pub const ADDRESS_FAMILY_NOT_SUPPORTED: u16 = 440u16

The address family (IPv4, IPv6) is not supported.

pub const WRONG_CREDENTIALS: u16 = 441u16

Incorrect credentials provided.

pub const UNSUPPORTED_TRANSPORT_PROTOCOL: u16 = 442u16

The transport protocol (UDP, TCP) is not supported.

pub const PEER_ADDRESS_FAMILY_MISMATCH: u16 = 443u16

The peer address family does not match the TURN allocation.

pub const ALLOCATION_QUOTA_REACHED: u16 = 486u16

This username has reached its limit of allocations currently allowed.

pub const ROLE_CONFLICT: u16 = 487u16

Requestor must switch ICE roles.

pub const SERVER_ERROR: u16 = 500u16

An unspecificed error has occurred.

pub const INSUFFICIENT_CAPACITY: u16 = 508u16

The server does not have capacity to handle this request.

pub fn builder<'reason>(code: u16) -> ErrorCodeBuilder<'reason>

Create a builder for creating a new ErrorCode Attribute

Examples

let error = ErrorCode::builder (400).reason("bad error").build().unwrap();
assert_eq!(error.code(), 400);
assert_eq!(error.reason(), "bad error");

pub fn new(code: u16, reason: &str) -> Result<Self, StunWriteError>

Create a new ErrorCode Attribute

Errors

• When the code value is out of range [300, 699]

Examples

let error = ErrorCode::new (400, "bad error").unwrap();
assert_eq!(error.code(), 400);
assert_eq!(error.reason(), "bad error");

pub fn code(&self) -> u16

The error code value

Examples

let error = ErrorCode::new (400, "bad error").unwrap();
assert_eq!(error.code(), 400);

pub fn reason(&self) -> &str

The error code reason string

Examples

let error = ErrorCode::new (400, "bad error").unwrap();
assert_eq!(error.reason(), "bad error");

pub fn default_reason_for_code(code: u16) -> &'static str

Return some default reason strings for some error code values

Currently the following are supported.

• 301 -> Try Alternate
• 400 -> Bad Request
• 401 -> Unauthorized
• 403 -> Forbidden
• 420 -> Unknown Attribute
• 437 -> Allocation Mismatch
• 438 -> Stale Nonce
• 440 -> Address Family Not Supported
• 441 -> Wrong Credentials
• 442 -> Supported Transport Protocol
• 443 -> Peer Address Family Mismatch
• 486 -> Allocation Quota Reached
• 487 -> Role Conflict
• 500 -> Server Error
• 508 -> Insufficient Capacity

Trait Implementations

impl Attribute for ErrorCode

fn get_type(&self) -> AttributeType

Retrieve the type of an Attribute.

fn length(&self) -> u16

Retrieve the length of an Attribute. This is not the padded length as stored in a Message and does not include the size of the attribute header.

impl AttributeFromRaw<'_> for ErrorCode

fn from_raw_ref(raw: &RawAttribute<'_>) -> Result<Self, StunParseError>

where Self: Sized,

Convert an Attribute from a RawAttribute

fn from_raw(raw: RawAttribute<'a>) -> Result<Self, StunParseError>

where Self: Sized,

Convert an Attribute from a RawAttribute

impl AttributeStaticType for ErrorCode

const TYPE: AttributeType

The AttributeType

impl AttributeWrite for ErrorCode

fn to_raw(&self) -> RawAttribute<'_>

Produce a RawAttribute from this Attribute

fn write_into_unchecked(&self, dest: &mut [u8])

Write attribute to the provided destination buffer.

impl Clone for ErrorCode

fn clone(&self) -> ErrorCode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ErrorCode

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

Formats the value using the given formatter.

impl Display for ErrorCode

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

Formats the value using the given formatter.

impl PartialEq for ErrorCode

fn eq(&self, other: &ErrorCode) -> 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 TryFrom<&RawAttribute<'_>> for ErrorCode

type Error = StunParseError

The type returned in the event of a conversion error.

fn try_from(raw: &RawAttribute<'_>) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for ErrorCode

impl StructuralPartialEq for ErrorCode