Struct 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 const MAX_SIZE: usize = 1_280usize

Maximum allowed packet size. By default limited to 1280 so that CoAP packets can be sent over TCP or UDP.

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 clear_all_options(&mut self)

Removes all options.

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.

pub fn to_bytes_with_limit(&self, limit: usize) -> Result<Vec<u8>, MessageError>

Returns a vector of bytes representing the Packet, using a custom limit instead of Packet::MAX_SIZE for the message size check.

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

Returns a vector of bytes representing the Packet, skipping the message size check against Packet::MAX_SIZE.

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.

impl MinimalWritableMessage for Packet

type Code = MessageClass

type OptionNumber = CoapOption

fn set_code(&mut self, code: Self::Code)

fn add_option(&mut self, option: Self::OptionNumber, data: &[u8])

Add an option to the message

fn set_payload(&mut self, payload: &[u8])

fn set_from_message<M>(&mut self, msg: &M)

where M: ReadableMessage,

Copy code, options and payload in from a readable message

fn add_option_str(&mut self, number: Self::OptionNumber, value: &str)

Shortcut for add_option(self, number, value.as_bytes()).

fn add_option_uint<U>(&mut self, number: Self::OptionNumber, value: U)

where U: Ux,

Shortcut for add_option on a buffer containing the uint encoded value

impl MinimalWritableMessage for Packet

type Code = MessageClass

See Self::set_code()

type OptionNumber = CoapOption

See Self::add_option()

type AddOptionError = Infallible

Error returned when an option can not be added (eg. for lack of space, or because an option of a higher number or even the payload was already set)

type SetPayloadError = Infallible

Error returned when setting the payload (eg. for lack of space, or when a message of that type does not take a payload)

type UnionError = Infallible

Error type into which either of the other errors, as well as the errors for conversion of the Code and OptionNumber, can be .into()ed.

fn set_code(&mut self, code: Self::Code)

Set the CoAP code of the message (in a request, that is the request method)

fn add_option( &mut self, option: Self::OptionNumber, data: &[u8], ) -> Result<(), Self::AddOptionError>

Add an option to the message

fn set_payload(&mut self, payload: &[u8]) -> Result<(), Self::SetPayloadError>

Set the payload to the message

fn set_from_message<M>(&mut self, msg: &M) -> Result<(), Self::UnionError>

where M: ReadableMessage + WithSortedOptions,

Copy code, options and payload in from a readable message

fn add_option_str( &mut self, number: Self::OptionNumber, value: &str, ) -> Result<(), Self::AddOptionError>

Shortcut for add_option(self, number, value.as_bytes()).

fn add_option_uint<U>( &mut self, number: Self::OptionNumber, value: U, ) -> Result<(), Self::AddOptionError>

where U: Unsigned + ToBytes,

Shortcut for add_option on a buffer containing the uint encoded value

fn with_static_type_annotation( &mut self, ) -> Option<RefMutWithStaticType<'_, Self>>

Type ID of Self or a ’static version of Self

fn convert_code_error(e: <Self::Code as Code>::Error) -> Self::UnionError

Auxiliary function for converting Self::Code::Error

fn convert_option_number_error( e: <Self::OptionNumber as OptionNumber>::Error, ) -> Self::UnionError

Auxiliary function for converting Self::OptionNumber::Error

fn convert_add_option_error(e: Self::AddOptionError) -> Self::UnionError

Auxiliary function for converting Self::AddOptionError

fn convert_set_payload_error(e: Self::SetPayloadError) -> Self::UnionError

Auxiliary function for converting Self::SetPayloadError

impl MutableWritableMessage for Packet

fn available_space(&self) -> usize

Number of bytes available for additional options, payload marker and payload

fn payload_mut(&mut self) -> &mut [u8]

👎Deprecated since 0.1.1: Use payload_mut_with_len instead

Legacy method for mutable access to the payload

fn payload_mut_with_len(&mut self, len: usize) -> &mut [u8]

Memory-map len bytes of the payload for writing

fn truncate(&mut self, length: usize)

Truncate an already-set payload to the given length; that payload must have been written to before using MinimalWritableMessage::set_payload, or with a suitable MutableWritableMessage::payload_mut_with_len call.

fn mutate_options<F>(&mut self, callback: F)

where F: FnMut(Self::OptionNumber, &mut [u8]),

Apply a callback to all options in sequence

impl MutableWritableMessage for Packet

fn available_space(&self) -> usize

Number of bytes available for additional options, payload marker and payload

fn payload_mut_with_len( &mut self, len: usize, ) -> Result<&mut [u8], Self::SetPayloadError>

Memory-map len bytes of the payload for writing

fn truncate(&mut self, length: usize) -> Result<(), Self::SetPayloadError>

Truncate an already-set payload to the given length; that payload must have been written to before using MinimalWritableMessage::set_payload, or with a suitable MutableWritableMessage::payload_mut_with_len call.

fn mutate_options<F>(&mut self, callback: F)

where F: FnMut(Self::OptionNumber, &mut [u8]),

Apply a callback to all options in sequence

impl PartialEq for Packet

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

type Code = MessageClass

See code; also used with MinimalWritableMessage::set_code()

type MessageOption<'a> = MessageOption<'a>

Type of an individual option, indiciating its option number and value

type OptionsIter<'a> = MessageOptionAdapter<'a>

See options

fn code(&self) -> Self::Code

Get the code (request method or response code) of the message

fn payload(&self) -> &[u8]

Get the payload set in the message

fn options(&self) -> Self::OptionsIter<'_>

Produce all options in arbitrary order as an iterator

impl ReadableMessage for Packet

type Code = MessageClass

See Self::code()

type MessageOption<'a> = MessageOption<'a>

Type of an individual option, indiciating its option number and value

type OptionsIter<'a> = MessageOptionAdapter<'a>

See Self::options()

fn code(&self) -> Self::Code

Get the code (request method or response code) of the message

fn payload(&self) -> &[u8]

Get the payload set in the message

fn options(&self) -> Self::OptionsIter<'_>

Produce all options in arbitrary order as an iterator

fn with_static_type_annotation(&self) -> Option<RefWithStaticType<'_, Self>>

Type ID of Self or a ’static version of Self

impl SeekWritableMessage for Packet

impl SeekWritableMessage for Packet

impl StructuralPartialEq for Packet

impl WithSortedOptions for Packet

impl WithSortedOptions for Packet