basenc 1.0.0-alpha.1

High-performance SIMD-accelerated Base64, Base32, and hex encoding and decoding with no_std support.
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


macro_rules! impl_encoding {
	(
		$(
			encode: [$(#[doc = $encode_example:literal])*],
			decode: [$(#[doc = $decode_example:literal])*],
			encode_into: [$(#[doc = $encode_into_example:literal])*],
			decode_into: [$(#[doc = $decode_into_example:literal])*],
		)?
	) => {
		#[cfg(feature = "std")]
		/// Encodes the input bytes.
		$(
			///
			/// # Examples
			$(#[doc = $encode_example])*
		)?
		#[inline]
		pub fn encode(&self, bytes: &[u8]) -> std::string::String {
			crate::Encoding::encode_bytes_into(self, bytes, std::string::String::new())
		}

		#[cfg(feature = "std")]
		/// Decodes the input string.
		$(
			///
			/// # Examples
			$(#[doc = $decode_example])*
		)?
		#[inline]
		pub fn decode(&self, string: &str) -> Result<std::vec::Vec<u8>, crate::Error> {
			self.decode_bytes(string.as_bytes())
		}

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

		/// Encodes into a buffer.
		$(
			///
			/// # Examples
			$(#[doc = $encode_into_example])*
		)?
		#[inline]
		pub fn encode_into<B: crate::EncodeBuf>(&self, bytes: &[u8], buffer: B) -> B::Output {
			crate::Encoding::encode_bytes_into(self, bytes, buffer)
		}

		/// Decodes into a buffer.
		$(
			///
			/// # Examples
			$(#[doc = $decode_into_example])*
		)?
		#[inline]
		pub fn decode_into<B: crate::DecodeBuf>(&self, string: &str, buffer: B) -> Result<B::Output, crate::Error> {
			self.decode_bytes_into(string.as_bytes(), buffer)
		}

		/// Decodes bytes into a buffer.
		#[inline]
		pub fn decode_bytes_into<B: crate::DecodeBuf>(&self, bytes: &[u8], buffer: B) -> Result<B::Output, crate::Error> {
			crate::Encoding::decode_bytes_into(self, 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)
		}
	};
}