deku_string 0.4.1

Encoding/decoding helpers for Deku, String, Vec in fixed, Pascal, .NET and C-style formats with length guarantee.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59

#![no_std]
#![deny(missing_docs)]
#![deny(missing_debug_implementations)]
#![forbid(clippy::allow_attributes_without_reason)]

//! Utility crate for [`Deku`] that provides convenient support for serializing and
//! deserializing String and Vec in a variety of binary formats.
//!
//! Some notable features:
//!
//! * [`StringDeku`] supports UTF-8, UTF-16 and UTF-32 encodings.
//! * Multiple layouts such as .Net, Pascal and zero-ended.
//! * Little and Big Endian support.
//! * Dynamic read and write without additional temporary structs and operations.
//! * No need to specify custom reader and writer functions.
//! * Compatible with Deku's derive macros and custom readers/writers.
//! * Supports `serde` and `defmt`.
//!
//! Read specific struct for example usage.
//!
//! [`Deku`]: https://docs.rs/deku

#[cfg(target_pointer_width = "16")]
compile_error!("Feel free to make a PR if you need this");

extern crate alloc;

mod common;
mod seven_bit;
mod string;
mod vec;

pub(crate) use common::InternalValue;
pub(crate) use common::deku_impl::{read_size_prefix, write_size_prefix};
pub(crate) use common::serde_impl::serde_shim_implementation;
pub(crate) use common::std_impl::std_shim_implementation;

pub use seven_bit::{SevenBitU8, SevenBitU16, SevenBitU32, SevenBitU64, SevenBitU128};
pub use string::{Encoding, StringDeku, StringLayout};
pub use vec::{VecDeku, VecLayout};

/// Size encoding for length-prefixed [`StringDeku`] and [`VecDeku`]
#[derive(Debug, Clone, Copy)]
#[non_exhaustive]
pub enum Size {
    /// 1 byte to encode length.
    U8,

    /// 2 bytes to encode length.
    U16,

    /// 4 bytes to encode length.
    U32,

    /// 7bit encoded u32 to encode length (.Net style).
    ///
    /// See [`crate::SevenBitU32`] for details.
    U32_7Bit,
}