#coap #transfer #constrained #logging #write #devices #buffer

no-std windowed-infinity

A data structure representing an infinite sequentially writable u8 vector of which a small view has writes to it preserved. This is primarily useful when implementing CoAP block-wise transfers, and also convenient for logging on constrained devices.

8 releases

0.1.7 Oct 30, 2024
0.1.6 Oct 30, 2024
0.1.5 Sep 10, 2024
0.1.4 Feb 1, 2023
0.1.0 Jan 22, 2019

#186 in No standard library

Download history 654/week @ 2024-08-23 774/week @ 2024-08-30 987/week @ 2024-09-06 1079/week @ 2024-09-13 521/week @ 2024-09-20 484/week @ 2024-09-27 477/week @ 2024-10-04 568/week @ 2024-10-11 646/week @ 2024-10-18 650/week @ 2024-10-25 868/week @ 2024-11-01 206/week @ 2024-11-08 554/week @ 2024-11-15 715/week @ 2024-11-22 329/week @ 2024-11-29 575/week @ 2024-12-06

2,239 downloads per month
Used in 5 crates (via coap-handler-implementati…)

MIT/Apache

34KB
508 lines

windowed-infinity License: MIT OR Apache-2.0 windowed-infinity on crates.io windowed-infinity on docs.rs Source Code Repository Rust Version: 1.75.0

This crate provides the WindowedInfinity struct and implementations of various traits to write to it.

Its primary purpose is to wrap a small buffer such that writes to it advance a cursor over a larger imaginary buffer, only persisting writes to the small buffer. After the buffer has been processed, a new WindowedInfinity can be set up and the writing process repeated. This is wasteful when the writes are computationally expensive, but convenient when operations only rarely exceed the buffer.

A typical practical example of a WindowedInfinity application is the implementation of CoAP block-wise transfer according to RFC7959; a simpler example is available in the demo.rs example.

Features

The set of traits implemented by WindowedInfinity depends on the configured cargo features:

  • With the std feature, it implements std::io::Write
  • With the with_serde_cbor feature, it uses serde_cbor’s trait unsealing feature to implement its Write trait.
  • Likewise, there are features for ciborium and minicbor. The minicbor version is a bit special in that there is both a with_minicbor / with_minicbor_0_19 feature.
  • Starting at with_minicbor_0_19, features carry a version. This allows users of different minicbor versions to coexist in the same crate, and moreover ensures that the dependencies expressed in the Cargo.toml files to describe the requirements precisely.
  • With the with_embedded_io_0_4, _0_6 and _async_0_6 features, the Write trait of embedded-io / -async is implemented.

Crate size

Compared to the original plan of “doing one thing, and doing that right”, this crate has grown a bit, in that it contains trait implementations for several serializers, and extra mechanism for combining the own writer with others (from cryptographic digests or CRCs). Both these are temporary – once there is a 1.0 version of embedded-io, the Tee will be split out into a dedicated crate (with only compatibility re-exports and constructors / destructors remaining), and once serializers start using the stable embedded-io, no more writer implementations will need to be added.

Dependencies

~400–760KB
~17K SLoC