Trait async_coap::message::MessageWrite

pub trait MessageWrite: OptionInsert {
    fn set_msg_type(&mut self, tt: MsgType);
    fn set_msg_id(&mut self, msg_id: MsgId);
    fn set_msg_code(&mut self, code: MsgCode);
    fn set_msg_token(&mut self, token: MsgToken);
    fn append_payload_bytes(&mut self, body: &[u8]) -> Result<(), Error>;
    fn clear(&mut self);

    fn append_payload_string(&mut self, body: &str) -> Result<(), Error> { ... }
    fn append_payload_u8(&mut self, b: u8) -> Result<(), Error> { ... }
    fn append_payload_char(&mut self, c: char) -> Result<(), Error> { ... }
}

Trait for writing/serializing a CoAP message.

Required methods

fn set_msg_type(&mut self, tt: MsgType)

Sets the CoAP message type. This may be called at any time during message writing without disrupting the operation. It may be called multiple times if necessary. The written value is that of the last call.

fn set_msg_id(&mut self, msg_id: MsgId)

Sets the CoAP message id. This may be called at any time during message writing without disrupting the operation. It may be called multiple times if necessary. The written value is that of the last call.

fn set_msg_code(&mut self, code: MsgCode)

Sets the CoAP message code. This may be called at any time during message writing without disrupting the operation. It may be called multiple times if necessary. The written value is that of the last call.

fn set_msg_token(&mut self, token: MsgToken)

Sets the CoAP message token. Calling this method out-of-order will cause any previously written options or payload to be lost. It may be called multiple times if necessary. The written value is that of the last call.

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

Appends bytes from the given slice body to the payload of the message. This method should only be called after the token and all options have been set. This method may be called multiple times, each time appending data to the payload.

fn clear(&mut self)

Removes the message payload along with all options.

Loading content...

Provided methods

fn append_payload_string(&mut self, body: &str) -> Result<(), Error>

Appends bytes from the UTF8 representation of the given string slice body to the payload of the message. This method should only be called after the token and all options have been set. This method may be called multiple times, each time appending data to the payload.

fn append_payload_u8(&mut self, b: u8) -> Result<(), Error>

Appends a single byte to the payload of the message. This method should only be called after the token and all options have been set. This method may be called multiple times, each time appending data to the payload.

fn append_payload_char(&mut self, c: char) -> Result<(), Error>

Appends the UTF8 representation for a single unicode character to the payload of the message. This method should only be called after the token and all options have been set. This method may be called multiple times, each time appending data to the payload.

Loading content...

Trait Implementations

impl<'a> Write for dyn MessageWrite + 'a

fn write_str(&mut self, s: &str) -> Result<(), Error>

Writes a slice of bytes into this writer, returning whether the write succeeded.

fn write_char(&mut self, c: char) -> Result<(), Error>

Writes a [char] into this writer, returning whether the write succeeded.

fn write_fmt(&mut self, args: Arguments) -> Result<(), Error>

Glue for usage of the [write!] macro with implementors of this trait.

impl<'a> Write for dyn MessageWrite + 'a

fn write(&mut self, buf: &[u8]) -> Result<usize, Error>

Write a buffer into this writer, returning how many bytes were written.

fn flush(&mut self) -> Result<(), Error>

Flush this output stream, ensuring that all intermediately buffered contents reach their destination.

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

Attempts to write an entire buffer into this writer.

fn write_vectored(&mut self, bufs: &[IoSlice]) -> Result<usize, Error>

Like write, except that it writes from a slice of buffers.

fn write_fmt(&mut self, fmt: Arguments) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered.

fn by_ref(&mut self) -> &mut Self

Creates a "by reference" adaptor for this instance of Write.

Implementors

impl MessageWrite for NullMessageWrite

fn set_msg_type(&mut self, _: MsgType)

fn set_msg_id(&mut self, _: u16)

fn set_msg_code(&mut self, _: MsgCode)

fn set_msg_token(&mut self, _: MsgToken)

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

fn clear(&mut self)

impl MessageWrite for VecMessageEncoder

fn set_msg_type(&mut self, tt: MsgType)

fn set_msg_id(&mut self, msg_id: u16)

fn set_msg_code(&mut self, code: MsgCode)

fn set_msg_token(&mut self, token: MsgToken)

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

fn clear(&mut self)

impl<'buf> MessageWrite for BufferMessageEncoder<'buf>

fn set_msg_type(&mut self, tt: MsgType)

fn set_msg_id(&mut self, msg_id: u16)

fn set_msg_code(&mut self, code: MsgCode)

fn set_msg_token(&mut self, token: MsgToken)

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

fn clear(&mut self)

Loading content...