ridl-rt 0.2.0

The vocabulary that code generated from ridl and a runtime agree on: identity, time, the envelope, samples, payload traits, interaction descriptors, ports, and contract and transport errors.
Documentation

ridl-rt

The library that code generated from ridl links, and a runtime implements.

ridl-rt defines, once, the vocabulary that generated code and a runtime agree on: identity and the interaction descriptors (contract), the payload encodings (encoding), the contract and transport errors (error), encoding and decoding a payload (payload), the ports a runtime implements and generated code calls (port), and time, the envelope, and the values a read returns (sample). It contains no runtime: a runtime is a separate crate that implements the port module's traits.

The crate is no_std, allocates nothing, contains no unsafe code, and has no dependency. It declares one cargo feature per payload encoding — flatbuffers, proto3, repr-c — and in this version each feature enables nothing.

Versioning

ridl-rt is a 0.x crate. A breaking change bumps the minor version (0.1 → 0.2), not the major version. A public struct whose fields are all public and that carries no #[non_exhaustive] cannot gain a field without a breaking change, because code outside the crate can build it as a struct literal: CatalogRef, Member, Timing, PayloadInfo, EncodedSizes, Encoded, Violation, RawSample, RawOccurrence, Claim, Watermark, Changed, Envelope, Sample, Occurrence. The public tuple structs — Ordinal, InterfaceNo, CatalogHash, Correlation, ClaimId, Timestamp, Duration — follow the same rule. So do the unit structs FlatBuffers, Proto3 and ReprC (src/encoding.rs): each is a marker type with no field that code outside the crate uses as a value or a pattern, so a field added to any of them breaks that code.

The open API questions are tracked at https://github.com/driftsys/ridl/issues/350.

ridl-rt supports Rust 1.83 or newer (rust-version = "1.83"). Raising that minimum is a breaking change, shipped in a 0.x minor release like any other.

The crate builds as edition 2021 and edition 2024: edition 2021 is tested with Rust 1.83 and with the pinned toolchain, and edition 2024 is tested with the pinned toolchain (edition 2024 did not exist before Rust 1.85, so the minimum cannot build it).

What 0.1 leaves out

  • streams
  • Inline
  • the three payload codecs (proto3, FlatBuffers, repr(C))
  • Encoding::FORMAT
  • Family
  • Access
  • Constrained
  • the runtimes (ridl-loopback, ridl-transport-ws)
  • the engine

License

MIT. See LICENSE.