Skip to content

hick v0.1.0

Choose a tag to compare

@al8n al8n released this 05 Jun 13:10
· 4 commits to main since this release
adbae72

First public release of hick — batteries-included, runtime-agnostic mDNS / DNS-SD for Rust, built on a Sans-I/O protocol core with pluggable async drivers.

Crates

All published to crates.io:

Crate Version Role
hick 0.1.0 batteries-included facade (core + default tokio driver)
mdns-proto 0.2.0 Sans-I/O protocol state machines (no_std-capable)
hick-udp 0.1.0 multicast UDP socket setup
hick-reactor 0.1.0 runtime-agnostic async driver (tokio & smol)
hick-compio 0.1.0 compio (thread-per-core) async driver
hick-smoltcp 0.1.0 bare-metal mDNS engine over smoltcp (no_std + alloc)
hick-embassy 0.1.0 embassy async driver, built on hick-smoltcp
hick-trace 0.1.0 tracing / metrics / stats / defmt observability shim

Highlights

  • Sans-I/O core — all protocol logic lives in mdns-proto as pure state machines (no sockets, threads, or clocks), deterministic and exhaustively unit-tested.
  • Runtime-agnostic — drive it from tokio, smol, or compio with no change to protocol behavior.
  • no_std and bare-metal — runs on alloc (or heapless, no allocator), plus hick-smoltcp / hick-embassy for embedded targets over smoltcp.
  • RFC 6762 / 6763 conformant — probing and announcing, name-conflict detection with automatic renaming, known-answer and duplicate-question suppression, TTL-accurate caching, and TTL=0 goodbyes on withdrawal.
  • unsafe-minimal — the protocol core is #![forbid(unsafe_code)]; unsafe is confined to the platform socket/control-message plumbing.
  • Observable, à la carte — opt into tracing spans, metrics counters, pollable stats, or defmt on embedded — each behind a feature flag and compiled out when unused.

Install

[dependencies]
hick = "0.1" # tokio runtime by default

For smol, compio, or bare-metal (smoltcp / embassy), enable the matching feature on hick — see the README for setup and a full example.


MSRV: Rust 1.91 (edition 2024). Licensed under MIT OR Apache-2.0.