base64-ng 2.0.1

no_std-first Base64 encoding and decoding with strict RFC 4648 APIs and optional SIMD
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
139

//! Internal ownership boundaries for the public 2.0 crate-root API.
#[allow(dead_code)]
pub(crate) mod alphabet;
#[cfg(feature = "alloc")]
mod append;
#[cfg(feature = "secrets")]
pub mod assurance;
pub(crate) mod backend_health;
mod bounded;
mod chunks;
pub mod compat;
mod const_transforms;
#[allow(dead_code)]
pub(crate) mod contracts;
mod decode_primitives;
mod formatting;
mod in_place;
#[allow(dead_code)]
pub(crate) mod incremental;
#[allow(dead_code)]
pub(crate) mod incremental_decoder;
pub mod legacy;
#[allow(dead_code)]
mod lifecycle;
mod ordinary;
#[cfg(feature = "alloc")]
mod ordinary_alloc;
#[cfg(feature = "alloc")]
mod ordinary_string;
mod profiles;
#[cfg(not(feature = "secrets"))]
pub(crate) mod secret;
#[cfg(feature = "secrets")]
pub mod secret;
#[cfg(feature = "secrets")]
mod secret_decoder;
#[cfg(feature = "secrets")]
mod secret_encoder;
#[cfg(all(kani, feature = "secrets"))]
pub(crate) use secret_encoder::{
    final_quantum_output_len_for_proof, require_disjoint_ranges_for_proof,
};
#[cfg(feature = "secrets")]
mod secret_in_place;
#[allow(dead_code)]
pub(crate) mod specifications;
pub mod web;
#[allow(dead_code)]
mod wrapping;

pub use alphabet::{BINHEX_ALPHABET, ValidatedAlphabet, ValidatedAlphabetError};
pub use backend_health::{
    BackendHealthSnapshot, BackendHealthState, BackendInitializationReport, initialize_backends,
};
pub use bounded::{BufferLengthError, DecodedArray, EncodedArray};
pub use chunks::{EncodedChunk, EncodedChunks};
pub use const_transforms::ConstTransformError;
pub use contracts::{
    AssuranceClass, Atomicity, BackendClass, BackendFault, Failure, InputError, InputErrorKind,
    OperationError, OutputFull, Progress, ProtocolScope, Status, Step, TerminalError,
};
#[cfg(kani)]
pub(crate) use decode_primitives::pack_full_quantum_for_proof;
#[cfg(all(kani, base64_ng_kani_advanced))]
pub(crate) use decode_primitives::tail_is_canonical_for_proof;
pub use formatting::{CountedSink, CountedWriteError, EncodedDisplay, FormatWriteError};
pub use in_place::InPlaceError;
#[cfg(kani)]
pub(crate) use in_place::{
    encoded_tail_len, quantum_decoded_len, require_in_place_disjoint_ranges_for_proof,
    tail_decoded_len,
};
pub use incremental::EncoderState;
pub use incremental_decoder::DecoderState;
pub use ordinary::OneShotError;
#[cfg(feature = "alloc")]
pub use ordinary_string::Base64String;
pub use profiles::{
    BCRYPT_ALPHABET_NO_PAD, BodyCodec, CRYPT_ALPHABET_NO_PAD, IMAP_MUTF7_ALPHABET_NO_PAD,
    MIME_BODY_STRICT, PBKDF2_ALPHABET_NO_PAD, PEM_BODY_CRLF, PEM_BODY_LF,
};
pub use specifications::{
    Base64, Codec, CodecBuilder, CodecBuilderError, CodecSettings, DecodePadding, EncodePadding,
    RuntimeSpec, STRICT_STANDARD_PADDED, STRICT_STANDARD_UNPADDED, STRICT_URL_SAFE_PADDED,
    STRICT_URL_SAFE_UNPADDED, StrictStandardPadded, StrictStandardUnpadded, StrictUrlSafePadded,
    StrictUrlSafeUnpadded, TrailingBits,
};
pub use wrapping::{
    LineEnding as BodyLineEnding, LineWrap as BodyWrap, LineWrapError as BodyWrapError,
};

#[cfg(test)]
mod alphabet_tests;
#[cfg(test)]
mod append_tests;
#[cfg(test)]
mod chunk_tests;
#[cfg(test)]
mod const_buffer_tests;
#[cfg(test)]
mod contract_tests;
#[cfg(test)]
mod fixtures;
#[cfg(test)]
mod formatting_tests;
#[cfg(test)]
mod in_place_tests;
#[cfg(test)]
mod incremental_decoder_tests;
#[cfg(test)]
mod incremental_decoder_unpadded_tests;
#[cfg(test)]
mod incremental_encoder_tests;
#[cfg(test)]
mod legacy_tests;
#[cfg(test)]
mod one_shot_tests;
#[cfg(all(test, feature = "alloc"))]
mod ordinary_string_tests;
#[cfg(test)]
mod profile_tests;
#[cfg(test)]
mod rfc4648_oracle;
#[cfg(test)]
mod secret_decoder_tests;
#[cfg(test)]
mod secret_encoder_tests;
#[cfg(test)]
mod secret_in_place_tests;
#[cfg(test)]
mod secret_storage_tests;
#[cfg(test)]
mod specification_tests;
#[cfg(test)]
mod web_no_alloc_tests;
#[cfg(test)]
mod web_tests;
#[cfg(test)]
mod wrapping_tests;