Enum libcoap_rs::protocol::CoapOptionType

#[repr(u16)]
#[non_exhaustive]
pub enum CoapOptionType {
Show 21 variants    IfMatch,
    UriHost,
    ETag,
    IfNoneMatch,
    UriPort,
    LocationPath,
    UriPath,
    ContentFormat,
    MaxAge,
    UriQuery,
    Accept,
    LocationQuery,
    ProxyUri,
    ProxyScheme,
    Size1,
    Size2,
    Block1,
    Block2,
    HopLimit,
    NoResponse,
    Observe,
}

Expand description

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)

This enum is marked as 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`

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

`UriHost`

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

`ETag`

ETag option (RFC 7252, Section 5.10.6).

`IfNoneMatch`

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

`UriPort`

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

`LocationPath`

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

`UriPath`

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

`ContentFormat`

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

`MaxAge`

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

`UriQuery`

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

`Accept`

Accept option (RFC 7252, Section 5.10.4).

`LocationQuery`

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

`ProxyUri`

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

`ProxyScheme`

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

`Size1`

Size1 option (RFC 7959, Section 4).

`Size2`

Size2 option (RFC 7959, Section 4).

`Block1`

Block1 option (RFC 7959, Section 2.1).

`Block2`

Block2 option (RFC 7959, Section 2.1).

`HopLimit`

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

`NoResponse`

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

`Observe`

Observe option (RFC 7641, Section 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. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

impl Debug for CoapOptionType

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

Formats the value using the given formatter. Read more

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. Read more

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. Read more

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. Read more

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. Read more

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. Read more

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. Read more

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. Read more

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. Read more

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. Read more

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. Read more

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. Read more

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. Read more

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. Read more

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. Read more

impl Hash for CoapOptionType

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher. Read more

1.3.0 · source

fn hash_slice<H>(data: &[Self], state: &mut H)where
H: Hasher,
Self: Sized,

Feeds a slice of this type into the given Hasher. Read more

impl PartialEq<CoapOptionType> for CoapOptionType

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

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

1.0.0 · source

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason. Read more

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

impl StructuralPartialEq for CoapOptionType

Auto Trait Implementations

impl RefUnwindSafe for CoapOptionType

impl Send for CoapOptionType

impl Sync for CoapOptionType

impl Unpin for CoapOptionType

impl UnwindSafe for CoapOptionType

Blanket Implementations

impl<T> Any for Twhere
T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for Twhere
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> ToOwned for Twhere
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for Twhere
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for Twhere
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for Twhere
V: MultiLane<T>,

fn vzip(self) -> V