Enum CoapOptionType

#[non_exhaustive]
#[repr(u16)]
pub enum CoapOptionType {
    IfMatch = 1,
    UriHost = 3,
    ETag = 4,
    IfNoneMatch = 5,
    Observe = 6,
    UriPort = 7,
    LocationPath = 8,
    Oscore = 9,
    UriPath = 11,
    ContentFormat = 12,
    MaxAge = 14,
    UriQuery = 15,
    HopLimit = 16,
    Accept = 17,
    QBlock1 = 19,
    LocationQuery = 20,
    Block2 = 23,
    Block1 = 27,
    Size2 = 28,
    QBlock2 = 31,
    ProxyUri = 35,
    ProxyScheme = 39,
    Size1 = 60,
    Echo = 252,
    NoResponse = 258,
    RTag = 292,
}

CoAP option types as defined in RFC 7252, Section 5.10 and later CoAP extensions.

The enum value corresponds to the appropriate option number and can be retrieved using [value] as u16 or to_raw_option_num().

See https://www.iana.org/assignments/core-parameters/core-parameters.xhtml#option-numbers for a list of option numbers registered with the IANA.

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.

IfMatch = 1

If-Match option (RFC 7252, Section 5.10.8.1).

UriHost = 3

Uri-Host option (RFC 7252, Section 5.10.1).

ETag = 4

ETag option (RFC 7252, Section 5.10.6).

IfNoneMatch = 5

If-None-Match option (RFC 7252, Section 5.10.8.2).

Observe = 6

Observe option (RFC 7641, Section 2).

UriPort = 7

Uri-Port option (RFC 7252, Section 5.10.1).

LocationPath = 8

Location-Path option (RFC 7252, Section 5.10.7).

Oscore = 9

OSCORE option (RFC 8613, Section 2.

UriPath = 11

Uri-Path option (RFC 7252, Section 5.10.1).

ContentFormat = 12

Content-Format option (RFC 7252, Section 5.10.3).

MaxAge = 14

Max-Age option (RFC 7252, Section 5.10.5).

UriQuery = 15

Uri-Query option (RFC 7252, Section 5.10.1).

HopLimit = 16

Hop-Limit option (RFC 8768, Section 3).

Accept = 17

Accept option (RFC 7252, Section 5.10.4).

QBlock1 = 19

Q-Block1 option (RFC 9177, Section 4).

LocationQuery = 20

Location-Query option (RFC 7252, Section 5.10.7).

Block2 = 23

Block2 option (RFC 7959, Section 2.1).

Block1 = 27

Block1 option (RFC 7959, Section 2.1).

Size2 = 28

Size2 option (RFC 7959, Section 4).

QBlock2 = 31

Q-Block2 option (RFC 9177, Section 4).

ProxyUri = 35

Proxy-Uri option (RFC 7252, Section 5.10.2).

ProxyScheme = 39

Proxy-Scheme option (RFC 7252, Section 5.10.2).

Size1 = 60

Size1 option (RFC 7959, Section 4).

Echo = 252

Echo option (RFC 9175, Section 2.2).

NoResponse = 258

No-Response option (RFC 7967, Section 2).

RTag = 292

Request-Tag option (RFC 9175, Section 3.2).

Implementations

impl CoapOptionType

pub fn to_raw_option_num(self) -> coap_option_num_t

Returns the option number this type belongs to.

pub fn max_len(&self) -> usize

Returns the maximum size in bytes that a value of this option type should have.

pub fn min_len(&self) -> usize

Returns the minimum size in bytes that a value of this option type should have.

Trait Implementations

impl Clone for CoapOptionType

fn clone(&self) -> CoapOptionType

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CoapOptionType

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

Formats the value using the given formatter.

impl FromPrimitive for CoapOptionType

fn from_i64(n: i64) -> Option<Self>

Converts an i64 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u64(n: u64) -> Option<Self>

Converts an u64 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_isize(n: isize) -> Option<Self>

Converts an isize to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i8(n: i8) -> Option<Self>

Converts an i8 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i16(n: i16) -> Option<Self>

Converts an i16 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i32(n: i32) -> Option<Self>

Converts an i32 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i128(n: i128) -> Option<Self>

Converts an i128 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_usize(n: usize) -> Option<Self>

Converts a usize to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u8(n: u8) -> Option<Self>

Converts an u8 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u16(n: u16) -> Option<Self>

Converts an u16 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u32(n: u32) -> Option<Self>

Converts an u32 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u128(n: u128) -> Option<Self>

Converts an u128 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_f32(n: f32) -> Option<Self>

Converts a f32 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_f64(n: f64) -> Option<Self>

Converts a f64 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

impl Hash for CoapOptionType

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 PartialEq for CoapOptionType

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

type Error = UnknownOptionError

The type returned in the event of a conversion error.

fn try_from(num: coap_option_num_t) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for CoapOptionType

impl Eq for CoapOptionType

impl StructuralPartialEq for CoapOptionType