https://github.com/covertness/coap-rs

A Constrained Application Protocol(CoAP) library implemented in Rust.
https://github.com/covertness/coap-rs

coap crates rust

Last synced: about 2 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/covertness/coap-rs
• Owner: Covertness
• License: mit
• Created: 2015-07-12T09:08:42.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2024-04-09T13:48:44.000Z (9 months ago)
• Last Synced: 2024-04-14T11:14:59.274Z (9 months ago)
• Topics: coap, crates, rust
• Language: Rust
• Homepage:
• Size: 39.8 MB
• Stars: 196
• Watchers: 12
• Forks: 47
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-edge - Rust CoAP - A Constrained Application Protocol (CoAP) library implemented in Rust. (_Table of Contents_ / Industrial)

README

        
# coap-rs

[![CircleCI](https://circleci.com/gh/Covertness/coap-rs.svg?style=svg)](https://circleci.com/gh/Covertness/coap-rs)

[![Windows Build Status](https://ci.appveyor.com/api/projects/status/ic36jdu4xy6doc59?svg=true)](https://ci.appveyor.com/project/Covertness/coap-rs)

![Downloads](https://img.shields.io/crates/d/coap.svg?style=flat)

[![Coverage Status](https://coveralls.io/repos/github/Covertness/coap-rs/badge.svg?branch=master)](https://coveralls.io/github/Covertness/coap-rs?branch=master)

[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE)

A fast and stable [Constrained Application Protocol(CoAP)](https://tools.ietf.org/html/rfc7252) library implemented in Rust.

Features:

- CoAP core protocol [RFC 7252](https://tools.ietf.org/rfc/rfc7252.txt)

- CoAP Observe option [RFC 7641](https://tools.ietf.org/rfc/rfc7641.txt)

- *Too Many Requests* Response Code [RFC 8516](https://tools.ietf.org/html/rfc8516)

- Block-Wise Transfers [RFC 7959](https://tools.ietf.org/html/rfc7959)

- DTLS support via [webrtc-rs](https://github.com/webrtc-rs/webrtc)

- Option to provide custom transports for client and server

[Documentation](https://docs.rs/coap/)

## Installation

First add this to your `Cargo.toml`:

```toml

[dependencies]

coap = "0.18"

coap-lite = "0.11.3"

tokio = {version = "^1.32", features = ["full"]}

```

## Example

### Server:

```rust

 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>| 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:

```rust

 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

```bash

$ cargo bench

```