Struct riot_wrappers::coap_message::ResponseMessage

pub struct ResponseMessage<'a> { /* private fields */ }

Available on riot_module_gcoap only.

Implementations

impl<'a> ResponseMessage<'a>

pub fn new(buf: &'a mut PacketBuffer) -> Self

pub fn finish(&self) -> isize

Trait Implementations

impl<'a> MinimalWritableMessage for ResponseMessage<'a>

type Code = u8

type OptionNumber = u16

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

fn add_option(&mut self, number: Self::OptionNumber, value: &[u8])

Add an option to the message

fn set_payload(&mut self, data: &[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<'a> MinimalWritableMessage for ResponseMessage<'a>

type Code = u8

See Self::set_code()

type OptionNumber = u16

See Self::add_option()

type AddOptionError = Error

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 = Error

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 = Error

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, number: Self::OptionNumber, value: &[u8] ) -> Result<(), Error>

Add an option to the message

fn set_payload(&mut self, data: &[u8]) -> Result<(), Error>

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 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<'a> MutableWritableMessage for ResponseMessage<'a>

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], Error>

Memory-map len bytes of the payload for writing

fn truncate(&mut self, len: usize) -> Result<(), Error>

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<'a> MutableWritableMessage for ResponseMessage<'a>

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 truncate(&mut self, len: 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

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

Memory-map len bytes of the payload for writing