basenc 0.2.3

Encoding and decoding hex, base64 and base32 with support for #[no_std].
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

use super::Encoding;

/// Padding policy.
#[derive(Copy, Clone, Debug, Default, Eq, PartialEq)]
pub enum Padding {
	/// No padding.
	None,
	/// Optional padding.
	///
	/// Padding accepted while decoding, not added while encoding.
	#[default]
	Optional,
	/// Strict padding.
	Strict,
}

/// Encoding with explicit padding policy.
#[derive(Clone, Debug)]
pub struct WithPad<'a, T> {
	pub(crate) encoding: &'a T,
	pub(crate) pad: Padding,
}

impl<'a, T> WithPad<'a, T> {
	/// Constructor.
	#[inline]
	pub const fn new(encoding: &'a T, pad: Padding) -> Self {
		WithPad { encoding, pad }
	}
}

impl<T> WithPad<'_, T> where Self: Encoding {
	#[cfg(feature = "std")]
	/// Encodes the input bytes.
	#[inline]
	pub fn encode(&self, bytes: &[u8]) -> std::string::String {
		crate::Encoding::encode_into(self, bytes, std::string::String::new())
	}

	#[cfg(feature = "std")]
	/// Decodes the input string.
	#[inline]
	pub fn decode(&self, string: &str) -> Result<std::vec::Vec<u8>, crate::Error> {
		crate::Encoding::decode_into(self, string.as_bytes(), std::vec::Vec::new())
	}

	/// Encodes into a buffer.
	#[inline]
	pub fn encode_into<B: crate::EncodeBuf>(&self, bytes: &[u8], buffer: B) -> B::Output {
		crate::Encoding::encode_into(self, bytes, buffer)
	}

	/// Decodes into a buffer.
	#[inline]
	pub fn decode_into<B: crate::DecodeBuf>(&self, string: &str, buffer: B) -> Result<B::Output, crate::Error> {
		crate::Encoding::decode_into(self, string.as_bytes(), buffer)
	}

	/// Wraps the encoding and bytes for display.
	#[inline]
	pub fn display<'a>(&'a self, bytes: &'a [u8]) -> crate::Display<'a, Self> {
		crate::Display::new(self, bytes)
	}
}