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

#![cfg_attr(not(any(feature = "std", test)), no_std)]

//! Joachim Henke's [basE91 encoding](http://base91.sourceforge.net) implementation for Rust.
//!
//! Also supports [xml-friendly base91](https://github.com/r-lyeh-archived/base)
//! implementation by [r-lyeh](https://github.com/r-lyeh), which supports quoting and is
//! JSON, XML and TSV friendly.
//!
//! # Library features
//!
//!  - no_std
//!  - Encode/Decode iterators
//!  - Canonical (Joachim Hanke) [implementation](http://base91.sourceforge.net)
//!  - Alternative XML, JSON and TSV friendly ([r-lyeh](https://github.com/r-lyeh)) [implementation](https://github.com/r-lyeh-archived/base)
//!
//! # Examples
//!
//! ## Using helpers
//!
//! ```
//! let source = "This is a random binary string";
//!
//! let encode_as_vec: Vec<u8> = base91::slice_encode(source.as_bytes());
//! let decode_as_vec: Vec<u8> = base91::slice_decode(&encode_as_vec);
//!
//! assert_eq!(
//!     "nX,<:WRT%yxtYQ:mbr4JB*H[LR/@Qj{o0aU=Z",
//!     String::from_utf8_lossy(&encode_as_vec)
//! );
//!
//! assert_eq!(
//!     "This is a random binary string",
//!     String::from_utf8_lossy(&decode_as_vec)
//! );
//! ```
//!
//!
//! ## Using Iterators
//!
//! ```
//! let source = "This is a random binary string";
//!
//! let as_vec: Vec<u8> = base91::EncodeIterator::new(source.bytes()).collect();
//! let as_str: String = base91::EncodeIterator::new(source.bytes()).as_char_iter().collect();
//!
//! assert_eq!(
//!     "nX,<:WRT%yxtYQ:mbr4JB*H[LR/@Qj{o0aU=Z",
//!     String::from_utf8_lossy(&as_vec)
//! );
//!
//! assert_eq!(
//!     "nX,<:WRT%yxtYQ:mbr4JB*H[LR/@Qj{o0aU=Z",
//!     as_str
//! );
//! ```
//!
//! ## Using Xml Friendly or another specific variation
//!
//! Warning!
//!   If you disable the feature `canonical` and enable the feature `xml-friendly`, then
//!   `base91::EncodeIterator` and `base91::DecodeIterator` will silently use XmlFriendly variant.
//!   In turn, all the helper functions use the iterators internally (`slice_encode` and `slice_decode`).
//!
//! ```
//! use base91::iter::{EncodeGenericIterator, DecodeGenericIterator};
//! use base91::codemap::XmlFriendly;
//!
//! let source = "This is a random binary string";
//!
//! let encode_as_vec: Vec<u8> = EncodeGenericIterator::<XmlFriendly, _>::new(source.bytes()).collect();
//! let decode_as_vec: Vec<u8> = DecodeGenericIterator::<XmlFriendly, _>::new(encode_as_vec.iter().copied()).collect();
//!
//! assert_eq!(
//!     "nX,-:WRT%yxtYQ:mbr4JB*H[LR/@Qj{o0aU=Z",
//!     String::from_utf8_lossy(&encode_as_vec)
//! );
//!
//! assert_eq!(
//!     "This is a random binary string",
//!     String::from_utf8_lossy(&decode_as_vec)
//! );
//! ```

pub mod codemap;
pub mod helpers;
pub mod iter;

pub use helpers::*;
pub use iter::{DecodeIterator, EncodeIterator};