MCPcopy Index your code
hub / github.com/Covertness/coap-rs

github.com/Covertness/coap-rs @0.23.0

Chat with this repo
repository ↗ · DeepWiki ↗ · release 0.23.0 ↗ · + Follow
243 symbols 789 edges 11 files 52 documented · 21% updated 12d ago0.12.0 · 2022-06-19★ 2375 open issues
What it actually does AI analysis from the code graph — generated when you open this
loading…
README

coap-rs

CircleCI Windows Build Status Downloads Coverage Status MIT licensed

A fast and stable Constrained Application Protocol(CoAP) library implemented in Rust.

Features: - CoAP core protocol RFC 7252 - CoAP Observe option RFC 7641 - Too Many Requests Response Code RFC 8516 - Block-Wise Transfers RFC 7959 - DTLS support via webrtc-rs - Option to provide custom transports for client and server

Documentation

Installation

First add this to your Cargo.toml:

[dependencies]
coap = "0.23"
coap-lite = "0.13.3"
tokio = {version = "^1.32", features = ["full"]}

Example

Server:

 use coap_lite::{RequestType as Method, CoapRequest};
 use coap::Server;
 use tokio::runtime::Runtime;
 use std::net::SocketAddr;
 fn main() {
     let addr = "127.0.0.1:5683";
    Runtime::new().unwrap().block_on(async move {
         let mut server = Server::new_udp(addr).unwrap();
         println!("Server up on {}", addr);

         server.run(|mut request: Box<CoapRequest<SocketAddr>>| async {
             match request.get_method() {
                 &Method::Get => println!("request by get {}", request.get_path()),
                 &Method::Post => println!("request by post {}", String::from_utf8(request.message.payload.clone()).unwrap()),
                 &Method::Put => println!("request by put {}", String::from_utf8(request.message.payload.clone()).unwrap()),
                 _ => println!("request by other method"),
             };

             match request.response {
                 Some(ref mut message) => {
                     message.message.payload = b"OK".to_vec();

                 },
                 _ => {}
             };
             return request
         }).await.unwrap();
     });
 }

Client:

 use coap_lite::{RequestType as Method, CoapRequest};
 use coap::{UdpCoAPClient};
 use tokio::main;
 #[tokio::main]
 async fn main() {
     let url = "coap://127.0.0.1:5683/Rust";
     println!("Client request: {}", url);

     let response = UdpCoAPClient::get(url).await.unwrap();
     println!("Server reply: {}", String::from_utf8(response.message.payload).unwrap());
 }

Benchmark

$ cargo bench

Extension points exported contracts — how you extend this code

ClientTransport (Interface)
A basic interface for a transport on the client representing a one-to-one connection between a client and server timeout [4 …
src/client.rs
Responder (Interface)
This trait represents a generic way to respond to a listener. If you want to implement your own listener, you have to im [2 …
src/server.rs
DtlsDropHook (Interface)
This trait is used to implement a hook that is called when a DTLS connection is dropped Only use this in case you need t [1 …
src/dtls.rs
TransportExt (Interface)
(no doc) [1 implementers]
src/client.rs
RequestHandler (Interface)
A trait for handling incoming requests. Use this instead of a closure if you want to modify some external state [1 implementers]
src/server.rs
Listener (Interface)
(no doc) [2 implementers]
src/server.rs
Dispatcher (Interface)
(no doc)
src/server.rs

Core symbols most depended-on inside this repo

clone
called by 86
src/client.rs
send
called by 41
src/dtls.rs
build
called by 27
src/request.rs
recv
called by 23
src/dtls.rs
send
called by 22
src/client.rs
spawn_server
called by 15
src/server.rs
run
called by 11
src/server.rs
recv
called by 11
src/client.rs

Shape

Method 117
Function 91
Class 25
Interface 7
Enum 3

Languages

Rust100%

Modules by API surface

src/client.rs102 symbols
src/server.rs49 symbols
src/dtls.rs39 symbols
src/observer.rs26 symbols
src/request.rs16 symbols
examples/client.rs6 symbols
examples/echo_with_dtls.rs2 symbols
examples/server.rs1 symbols
examples/echo.rs1 symbols
benches/server.rs1 symbols

For agents

$ claude mcp add coap-rs \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact

Ask about this repo answers extend the page