coap-message 0.1.0

#![no_std]
//! CoAP mesage abstraction
//!
//! This crate defines interfaces for readable and writable CoAP messages. Thus, it allows CoAP
//! servers (and possibly clients) to be written independent of the actual CoAP library that is
//! used to serialize and deserialize the messages to the protocol.
//!
//! It also provides some trivial implementations of the types: [Code] for [u8], [OptionNumber]
//! for [u16], as well as the [heapmessage::HeapMessage] for easy message storage on alloc systems.
//!
//! Error handling
//! --------------
//!
//! The readable message types are designed with minimal fallability -- for example, iterating over
//! the options can not raise a "premature end of message" style error. This encodes the concept
//! that having a message type implies validity of the message. It is backed by currently used
//! libraries (RIOT's Gcoap, jnet-coap) performing the necessary validation steps when constructing
//! message objects.
//!
//! Whether this is a good idea remains to be seen.
//!
//! Libraries that insist on minimizing the cycles spent parsing can opt to present invalid
//! messages in truncated form, but need to be aware that this has important security implications.

mod message;
mod numbers;

pub use message::{
    MessageOption, MinimalWritableMessage, MutableWritableMessage, ReadableMessage,
    SeekWritableMessage, WithSortedOptions,
};

pub use numbers::{Code, OptionNumber, FromOtherOption};

#[cfg(feature = "typenum_test")]
mod typenum_test;

#[cfg(feature = "alloc")]
pub mod heapmessage;

pub mod numtraits;