Skip to content

Commit

Permalink
doc(coapcore): Initial documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
chrysn committed Jul 2, 2024
1 parent ae1cd50 commit 40cb5c5
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions src/lib/coapcore/src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,16 @@
//! A CoAP stack for embedded devices with built-in OSCORE/EDHOC support
//! ====================================================================
//!
//! This crate provides an asynchronous task that serves CoAP requests on a UDP port provided by
//! the application as an `embedded-nal` socket, and process CoAP along with its security
//! components OSCORE and EDHOC before passing on authorized requests to the application.
//!
//! The crate is under heavy development: Its API is in flux, and so far it does not yet provide
//! the CoAP server itself, but merely a middleware. (Providing the full CoAP will be a requirement
//! for at least as long as the OSCORE component is tightly coupled to a particular implementation
//! of [`coap-message`]).
#![no_std]

// Might warrant a standalone crate at some point
//
// This is pub only to make the doctests run (but the crate's pub-ness needs a major overhaul
Expand Down

0 comments on commit 40cb5c5

Please sign in to comment.