devela/data/codec/
types.rs

Help
1// devela::data::codec::types
2
3/// The primary mode for data encoding.
4///
5/// This enum is used to guide encoding/decoding strategies.
6#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
7pub enum EncodingMode {
8    /// Text-based and intended to be human-readable.
9    ///
10    /// Often used for formats like TOML, JSON, XML, etc., where readability
11    /// and editability are prioritized over storage or transmission efficiency.
12    Textual,
13
14    /// Binary-based, optimized for machine processing.
15    ///
16    /// Typically used in high-performance or low-level contexts where
17    /// efficiency, compactness, and speed are more important than readability.
18    /// Examples include formats like Protobuf and Bincode.
19    Binary,
20}
21
22/// The type of compression applied to data.
23///
24/// This enum is used to specify whether the compression algorithm prioritizes
25/// retaining all original data or reducing file size, potentially at the cost
26/// of data fidelity.
27#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
28pub enum CompressionMode {
29    /// Compression that retains all original data.
30    ///
31    /// Commonly used when data accuracy is critical, such as with formats like
32    /// PNG, ZIP, or FLAC. All original data can be perfectly restored.
33    Lossless,
34
35    /// Compression that sacrifices some data accuracy for reduced size.
36    ///
37    /// Used in cases where smaller size is more important than retaining all
38    /// original data, such as with formats like JPEG, MP3, or MPEG.
39    /// Some data is discarded to achieve a more compact representation.
40    Lossy,
41}
devela/data/codec/types.rs

devela/data/codec/
types.rs
