Struct ErrorCode

pub struct ErrorCode { /* private fields */ }

The ErrorCode contains a numeric error code value in the range of 300 to 699 plus a textual reason phrase encoded in UTF-8 RFC3629; it is also consistent in its code assignments and semantics with SIP RFC3261 and HTTP RFC7231. The reason phrase is meant for diagnostic purposes and can be anything appropriate for the error code. Recommended reason phrases for the defined error codes are included in the IANA registry for error codes. The reason phrase MUST be a UTF-8-encoded RFC3629 sequence of fewer than 128 characters (which can be as long as 509 bytes when encoding them or 763 bytes when decoding them).

Examples

 let attr = ErrorCode::new(420, "Unknown Attribute")?;
 assert_eq!(attr.class(), 4);
 assert_eq!(attr.number(), 20);
 assert_eq!(attr.error_code(), 420);
 assert_eq!(attr.reason(), "Unknown Attribute");

Implementations

impl ErrorCode

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

Creates a new ErrorCode type.

Arguments:

• error_code - The numeric error code.
• reason - The reason phrase.

Return:

The ErrorCode type or a StunError if the numeric error value is not in the range of 300 to 699.

pub fn error_code(&self) -> u16

Returns the numeric error code value .

pub fn class(&self) -> u8

Returns the class of the error code (the hundreds digit).

pub fn number(&self) -> u8

Returns the binary encoding of the error code modulo 100.

pub fn reason(&self) -> &str

Returns the reason phrase associated to this error.

Trait Implementations

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 From<ErrorCode> for ErrorCode

fn from(error: ErrorCodeType) -> Self

Converts to this type from the input type.

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 Eq for ErrorCode

impl StructuralPartialEq for ErrorCode