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
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138

//! Read/write 7-bit int as described in MSDN.
#![cfg_attr(
    feature = "defmt",
    allow(clippy::missing_asserts_for_indexing, reason = "Defmt impl")
)]

mod deku_impl;
mod lib_impl;

/// Variable length 7-bit encoded u8.
///
/// MSDN links for .NET 9.0 documentation, implementation is based on:
/// * [`BinaryReader.read()`]
/// * [`BinaryWriter.write()`]
///
/// <div class="warning">Endianness isn't supported per reference documentation</div>
///
/// Example usage of [`SevenBitU8`]:
///
/// ```rust
/// use deku_string::{Encoding, SevenBitU8, Size, StringDeku, StringLayout};
///
/// #[derive(Debug, Clone, PartialEq, deku::DekuRead, deku::DekuWrite)]
/// struct SampleModel {
///     // 7-bit encoded u8
///     value: SevenBitU8,
/// }
/// ```
///
/// [`BinaryReader.read()`]: https://learn.microsoft.com/en-us/dotnet/api/system.io.binaryreader.read7bitencodedint?view=net-9.0
/// [`BinaryWriter.write()`]: https://learn.microsoft.com/en-us/dotnet/api/system.io.binarywriter.write7bitencodedint?view=net-9.0
#[derive(Clone, Default, PartialEq, PartialOrd, Eq, Ord)]
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
pub struct SevenBitU8(u8);

/// Variable length 7-bit encoded u16.
///
/// MSDN links for .NET 9.0 documentation, implementation is based on:
/// * [`BinaryReader.read()`]
/// * [`BinaryWriter.write()`]
///
/// <div class="warning">Endianness isn't supported per reference documentation</div>
///
/// Example usage of [`SevenBitU16`]:
///
/// ```rust
/// use deku_string::{Encoding, SevenBitU16, Size, StringDeku, StringLayout};
///
/// #[derive(Debug, Clone, PartialEq, deku::DekuRead, deku::DekuWrite)]
/// struct SampleModel {
///     // 7-bit encoded u16
///     value: SevenBitU16,
/// }
/// ```
///
/// [`BinaryReader.read()`]: https://learn.microsoft.com/en-us/dotnet/api/system.io.binaryreader.read7bitencodedint?view=net-9.0
/// [`BinaryWriter.write()`]: https://learn.microsoft.com/en-us/dotnet/api/system.io.binarywriter.write7bitencodedint?view=net-9.0
#[derive(Clone, Default, PartialEq, PartialOrd, Eq, Ord)]
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
pub struct SevenBitU16(u16);

/// Variable length 7-bit encoded u32.
///
/// MSDN links for .NET 9.0 documentation, implementation is based on:
/// * [`BinaryReader.read()`]
/// * [`BinaryWriter.write()`]
///
/// <div class="warning">Endianness isn't supported per reference documentation</div>
///
/// Example usage of [`SevenBitU32`]:
///
/// ```rust
/// use deku_string::{Encoding, SevenBitU32, Size, StringDeku, StringLayout};
///
/// #[derive(Debug, Clone, PartialEq, deku::DekuRead, deku::DekuWrite)]
/// struct SampleModel {
///     // 7-bit encoded u32
///     value: SevenBitU32,
/// }
/// ```
///
/// [`BinaryReader.read()`]: https://learn.microsoft.com/en-us/dotnet/api/system.io.binaryreader.read7bitencodedint?view=net-9.0
/// [`BinaryWriter.write()`]: https://learn.microsoft.com/en-us/dotnet/api/system.io.binarywriter.write7bitencodedint?view=net-9.0
#[derive(Clone, Default, PartialEq, PartialOrd, Eq, Ord)]
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
pub struct SevenBitU32(u32);

/// Variable length 7-bit encoded u64.
///
/// MSDN links for .NET 9.0 documentation, implementation is based on:
/// * [`BinaryReader.read()`]
/// * [`BinaryWriter.write()`]
///
/// <div class="warning">Endianness isn't supported per reference documentation</div>
///
/// Example usage of [`SevenBitU64`]:
///
/// ```rust
/// use deku_string::{Encoding, SevenBitU64, Size, StringDeku, StringLayout};
///
/// #[derive(Debug, Clone, PartialEq, deku::DekuRead, deku::DekuWrite)]
/// struct SampleModel {
///     // 7-bit encoded u64
///     value: SevenBitU64,
/// }
/// ```
///
/// [`BinaryReader.read()`]: https://learn.microsoft.com/en-us/dotnet/api/system.io.binaryreader.read7bitencodedint?view=net-9.0
/// [`BinaryWriter.write()`]: https://learn.microsoft.com/en-us/dotnet/api/system.io.binarywriter.write7bitencodedint?view=net-9.0
#[derive(Clone, Default, PartialEq, PartialOrd, Eq, Ord)]
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
pub struct SevenBitU64(u64);

/// Variable length 7-bit encoded u128.
///
/// MSDN links for .NET 9.0 documentation, implementation is based on:
/// * [`BinaryReader.read()`]
/// * [`BinaryWriter.write()`]
///
/// <div class="warning">Endianness isn't supported per reference documentation</div>
///
/// Example usage of [`SevenBitU128`]:
///
/// ```rust
/// use deku_string::{Encoding, SevenBitU128, Size, StringDeku, StringLayout};
///
/// #[derive(Debug, Clone, PartialEq, deku::DekuRead, deku::DekuWrite)]
/// struct SampleModel {
///     // 7-bit encoded u128
///     value: SevenBitU128,
/// }
/// ```
///
/// [`BinaryReader.read()`]: https://learn.microsoft.com/en-us/dotnet/api/system.io.binaryreader.read7bitencodedint?view=net-9.0
/// [`BinaryWriter.write()`]: https://learn.microsoft.com/en-us/dotnet/api/system.io.binarywriter.write7bitencodedint?view=net-9.0
#[derive(Clone, Default, PartialEq, PartialOrd, Eq, Ord)]
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
pub struct SevenBitU128(u128);