Struct kwap_msg::Code

pub struct Code {
    pub class: u8,
    pub detail: u8,
}

Low-level representation of the code of a message. Identifying it as a request or response

Examples

use kwap_msg::Code;
assert_eq!(Code { class: 2, detail: 5 }.to_string(), "2.05".to_string())

See RFC7252 - Message Details for context

Fields

class: u8

The “class” of message codes identify it as a request or response, and provides the class of response status:

class	meaning
0	Message is a request
2	Message is a success response
4	Message is a client error response
5	Message is a server error response

detail: u8

2-digit integer (range [0, 32)) that provides granular information about the response status.

Will always be 0 for requests.

Implementations

impl Code

pub fn to_human(&self) -> [char; 4]

Get the human string representation of a message code

Returns

A char array

This is to avoid unnecessary heap allocation, you can create a String with FromIterator::<String>::from_iter, or if the alloc feature of kwap is enabled there is a ToString implementation provided for Code.

use kwap_msg::Code;

let code = Code { class: 2, detail: 5 };
let chars = code.to_human();
let string = String::from_iter(chars);
assert_eq!(string, "2.05".to_string());

Trait Implementations

impl Clone for Code

fn clone(&self) -> Code

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Code

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

Formats the value using the given formatter.

impl From<Code> for u8

fn from(code: Code) -> u8

Performs the conversion.

impl From<u8> for Code

fn from(b: u8) -> Self

Performs the conversion.

impl PartialEq<Code> for Code

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<Code> for Code

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl ToString for Code

fn to_string(&self) -> String

Converts the given value to a String.

impl Copy for Code

impl StructuralPartialEq for Code