devela/data/codec/
mod.rs

Help
1// devela::data::codec
2//
3//! Abstractions for encoding and decoding data.
4#![doc = crate::doc_!(modules: crate::data; codec: hash)]
5#![doc = crate::doc_!(newline)]
6//!
7#![doc = crate::doc_!(extends: hash)]
8//!
9//! ## Determinism & Side Effects
10//! Encoding and decoding should be **deterministic**.
11//! Implementations should avoid introducing side effects where possible.
12//!
13//! **Potential sources of non-determinism:**
14//! - Writing to or reading from external files or devices.
15//! - Using randomness during encoding or decoding.
16//! - Modifying or depending on global state.
17//!
18//! ## Example
19//! ```
20//! use devela::{Encodable, CodecLenValue, IoWrite};
21//!
22//! # #[cfg(feature = "alloc")] { use devela::Vec;
23//! let mut buf = Vec::new();
24//! CodecLenValue::<_, u8>::new("hello").encode(&mut buf).unwrap();
25//! assert_eq!(&buf, b"\x05hello");
26//! # }
27//! ```
28//
29
30mod bit; // bitfield handling and binary transformations.
31mod encode; // encoders and decoders.
32mod radix; // radix-based encodings (Base32, Base64, Base58…).
33mod types;
34
35pub mod hash; // hashing algorithms (Fnv, Fx, MD5).
36
37crate::items! { // structural access: _mods, _pub_mods, _all, _always
38    #[allow(unused)]
39    pub use _mods::*;
40    #[allow(unused)] #[doc(hidden, no_inline)]
41    pub use {_always::*, _pub_mods::*};
42
43    mod _mods { #![allow(unused)]
44        pub use super::{bit::_all::*, encode::_all::*, radix::_all::*, types::*};
45        // WIPZONE
46        // pub use serde::_all::*;
47    }
48    mod _pub_mods { #![allow(unused)]
49        pub use super::{
50            hash::_all::*,
51        };
52    }
53    pub(super) mod _all {
54        #[doc(inline)]
55        pub use super::_mods::*;
56    }
57    pub(super) mod _always { #![allow(unused)]
58        pub use super::{_mods::*, _pub_mods::*};
59        pub use super::hash::_always::*;
60    }
61}
62// WIP ZONE
63// mod compress; // compression algorithms
64// mod hex; // Hexadecimal literals and conversions.
65// mod rle; // Run-length encoding and similar techniques.
66// mod serde; // structured serialization/deserialization.
devela/data/codec/mod.rs

devela/data/codec/
mod.rs
