iroh_blobs/
format.rs

1//! Defines data formats for HashSeq.
2//!
3//! The exact details how to use a HashSeq for specific purposes is up to the
4//! user. However, the following approach is used by iroh formats:
5//!
6//! The first child blob is a metadata blob. It starts with a header, followed
7//! by serialized metadata. We mostly use [postcard] for serialization. The
8//! metadata either implicitly or explicitly refers to the other blobs in the
9//! HashSeq by index.
10//!
11//! In a very simple case, the metadata just an array of items, where each item
12//! is the metadata for the corresponding blob. The metadata array will have
13//! n-1 items, where n is the number of blobs in the HashSeq.
14//!
15//! [postcard]: https://docs.rs/postcard/latest/postcard/
16pub mod collection;