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
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
use crate::{B32CharSet, B64CharSet, Encoding, HexCharSet};
/// For configuring how a string is encoded/decoded.
///
/// `Config` has these values by default:
///
/// - `end_padding = true`
///
#[derive(Debug, Copy, Clone)]
pub struct Config {
pub(crate) encoding: Encoding,
pub(crate) end_padding: bool,
}
impl Config {
/// Constructs a `Config` from an [Encoding]
///
/// You can use [the associated constants](#associated-consts) for a more
/// concise way to get a `Config`
///
/// # Example
///
/// ```rust
/// use const_base::{B64CharSet, Config, Encoding, encode};
///
/// // The same as `Config::B64`
/// const CFG: Config = Config::new(Encoding::Base64(B64CharSet::Standard));
///
/// assert_eq!(encode!("Rust", CFG), "UnVzdA==")
///
/// ```
pub const fn new(encoding: Encoding) -> Self {
Self {
encoding,
end_padding: true,
}
}
/// Determines whether the string has padding at the end.
/// This is `true` by default.
///
/// For each encoding, the strings are padded to a multiple:
///
/// - Base64: pads to be a multiple of 4 long, with `=`.
/// - Base32: pads to be a multiple of 8 long, with `=`.
/// - Hexadecimal: requires no padding
///
/// # Examples
///
/// ### Base 64
///
/// ```rust
/// use const_base::{Config, encode};
///
/// assert_eq!(encode!("Rust", Config::B64), "UnVzdA==");
///
/// assert_eq!(encode!("Rust", Config::B64.end_padding(true)), "UnVzdA==");
///
/// assert_eq!(encode!("Rust", Config::B64.end_padding(false)), "UnVzdA");
///
/// ```
///
/// ### Base 32
///
/// ```rust
/// use const_base::{Config, encode};
///
/// assert_eq!(encode!("Rustic", Config::B32), "KJ2XG5DJMM======");
///
/// assert_eq!(encode!("Rustic", Config::B32.end_padding(true)), "KJ2XG5DJMM======");
///
/// assert_eq!(encode!("Rustic", Config::B32.end_padding(false)), "KJ2XG5DJMM");
///
/// ```
pub const fn end_padding(mut self, have: bool) -> Self {
self.end_padding = have;
self
}
/// A different way to call [`encode`](crate::encode()).
///
/// # Example
///
/// ```rust
/// use const_base::{Config, encode};
///
/// assert_eq!(Config::B64.encode::<8>(b"Rust").unwrap(), "UnVzdA==");
/// ```
#[inline(always)]
pub const fn encode<const OUT: usize>(
self,
input: &[u8],
) -> Result<crate::ArrayStr<OUT>, crate::WrongOutputLength> {
crate::encode(input, self)
}
/// A different way to call [`decode`](crate::decode()).
///
/// # Example
///
/// ```rust
/// use const_base::{Config, decode};
///
/// assert_eq!(Config::B64.decode::<4>(b"UnVzdA=="), Ok(*b"Rust"));
/// ```
#[inline(always)]
pub const fn decode<const OUT: usize>(
self,
input: &[u8],
) -> Result<[u8; OUT], crate::DecodeError> {
crate::decode(input, self)
}
}
/// <div id = "associated-consts"></div>
impl Config {
/// Configuration with the [`Base64`](crate::Encoding::Base64) encoding,
/// using the [`Standard`](crate::B64CharSet::Standard) character set.
///
/// # Example
///
/// ```rust
/// use const_base::{Config, encode};
///
/// assert_eq!(encode!(&[23, 239, 192], Config::B64), "F+/A");
/// ```
///
pub const B64: Self = Self::new(Encoding::Base64(B64CharSet::Standard));
/// Configuration with the [`Base64`](crate::Encoding::Base64) encoding,
/// using the [`UrlSafe`](crate::B64CharSet::UrlSafe) character set.
///
/// # Example
///
/// ```rust
/// use const_base::{Config, encode};
///
/// assert_eq!(encode!(&[23, 239, 192], Config::B64_URL_SAFE), "F-_A");
/// ```
///
pub const B64_URL_SAFE: Self = Self::new(Encoding::Base64(B64CharSet::UrlSafe));
/// Configuration with the [`Base32`](crate::Encoding::Base32) encoding,
/// using the [`Standard`](crate::B32CharSet::Standard) character set.
///
///
/// # Example
///
/// ```rust
/// use const_base::{Config, encode};
///
/// assert_eq!(encode!(b"neat", Config::B32), "NZSWC5A=");
/// ```
///
pub const B32: Self = Self::new(Encoding::Base32(B32CharSet::Standard));
/// Configuration with the [`Hex`](crate::Encoding::Hex) (hexadecimal) encoding,
/// using the [`Uppercase`](crate::HexCharSet::Uppercase) character set.
///
///
/// # Example
///
/// ```rust
/// use const_base::{Config, decode, encode};
///
/// assert_eq!(encode!(&[0xF1, 0x00, 0x0f], Config::HEX), "F1000F");
///
/// // Hexademical decoding allows mixing uppercase and lowercase
/// assert_eq!(decode!(b"beefBEEF", Config::HEX), &[0xBE, 0xEF, 0xBE, 0xEF]);
/// ```
///
pub const HEX: Self = Self::new(Encoding::Hex(HexCharSet::Uppercase));
/// Configuration with the [`Hex`](crate::Encoding::Hex) (hexadecimal) encoding,
/// using the [`Lowercase`](crate::HexCharSet::Lowercase) character set.
///
///
/// # Example
///
/// ```rust
/// use const_base::{Config, decode, encode};
///
/// assert_eq!(encode!(&[0xf1, 0x00, 0x0f], Config::HEX_LOWER), "f1000f");
///
/// // Hexademical decoding allows mixing uppercase and lowercase
/// assert_eq!(decode!(b"beefBEEF", Config::HEX_LOWER), &[0xBE, 0xEF, 0xBE, 0xEF]);
/// ```
///
pub const HEX_LOWER: Self = Self::new(Encoding::Hex(HexCharSet::Lowercase));
}