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

use deku_string::{Size, StringLayout};

/// How many bytes (for UTF-8) or u16 (for UTF-16) should be present in the
/// buffer
pub const FIXED_LENGTH: usize = 5;

/// Layout for fixed string buffer with enforced zero byte presence
pub const LAYOUT_FIXED_FORCE_ZERO: StringLayout = StringLayout::FixedLength {
    size: FIXED_LENGTH,
    allow_no_null: false,
};

/// Layout for fixed string buffer with non-enforced zero byte presence
pub const LAYOUT_FIXED_ALLOW_NO_ZERO: StringLayout = StringLayout::FixedLength {
    size: FIXED_LENGTH,
    allow_no_null: true,
};

/// Layout for Pascal-like string with 1 byte of length
pub const LAYOUT_PREFIX_U8: StringLayout = StringLayout::LengthPrefix(Size::U8);

/// Layout for Pascal-like string with 2 bytes of length
pub const LAYOUT_PREFIX_U16: StringLayout = StringLayout::LengthPrefix(Size::U16);

/// Layout for Pascal-like string with 4 bytes of length
pub const LAYOUT_PREFIX_U32: StringLayout = StringLayout::LengthPrefix(Size::U32);

/// Layout for .Net-like string with u32 length
pub const LAYOUT_PREFIX_U32_7BIT: StringLayout =
    StringLayout::LengthPrefix(Size::U32_7Bit);

/// Layout for C-like string
pub const LAYOUT_ZERO_ENDED: StringLayout = StringLayout::ZeroEnded;