Struct coap_lite::Packet

pub struct Packet {
    pub header: Header,
    pub payload: Vec<u8>,
    /* private fields */
}

The CoAP packet.

Fields

header: Header

payload: Vec<u8>

Implementations

impl Packet

pub fn new() -> Packet

Creates a new packet.

pub fn options(&self) -> Iter<'_, u16, LinkedList<Vec<u8>>>

Returns an iterator over the options of the packet.

pub fn set_token(&mut self, token: Vec<u8>)

Sets the token.

pub fn get_token(&self) -> &[u8]

Returns the token.

pub fn set_option(&mut self, tp: CoapOption, value: LinkedList<Vec<u8>>)

Sets an option’s values.

pub fn set_options_as<T: OptionValueType>(
    &mut self,
    tp: CoapOption,
    value: LinkedList<T>
)

Sets an option’s values using a structured option value format.

pub fn get_option(&self, tp: CoapOption) -> Option<&LinkedList<Vec<u8>>>

Returns an option’s values.

pub fn get_options_as<T: OptionValueType>(
    &self,
    tp: CoapOption
) -> Option<LinkedList<Result<T, IncompatibleOptionValueFormat>>>

Returns an option’s values all decoded using the specified structured option value format.

pub fn get_first_option(&self, tp: CoapOption) -> Option<&Vec<u8>>

Returns an option’s first value as a convenience when only one is expected.

pub fn get_first_option_as<T: OptionValueType>(
    &self,
    tp: CoapOption
) -> Option<Result<T, IncompatibleOptionValueFormat>>

Returns an option’s first value as a convenience when only one is expected.

pub fn add_option(&mut self, tp: CoapOption, value: Vec<u8>)

Adds an option value.

pub fn add_option_as<T: OptionValueType>(&mut self, tp: CoapOption, value: T)

Adds an option value using a structured option value format.

pub fn clear_option(&mut self, tp: CoapOption)

Removes an option.

pub fn set_content_format(&mut self, cf: ContentFormat)

Sets the content-format.

pub fn get_content_format(&self) -> Option<ContentFormat>

Returns the content-format.

pub fn set_observe_value(&mut self, value: u32)

Sets the value of the observe option.

pub fn get_observe_value(
    &self
) -> Option<Result<u32, IncompatibleOptionValueFormat>>

Returns the value of the observe option.

pub fn from_bytes(buf: &[u8]) -> Result<Packet, MessageError>

Decodes a byte slice and constructs the equivalent packet.

pub fn to_bytes(&self) -> Result<Vec<u8>, MessageError>

Returns a vector of bytes representing the Packet.

Trait Implementations

impl Clone for Packet

fn clone(&self) -> Packet

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Packet

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

Formats the value using the given formatter.

impl Default for Packet

fn default() -> Packet

Returns the “default value” for a type.