bases64/lib.rs
1//! The bases crate base on RFC4648
2//!
3//! bases 库是基于规范文档 RFC4648 编写的库
4//!
5//! This crate is very simple
6//!
7//! 这个库非常简单易用
8//!
9//! Usually, we use encode () and decode (). But if Base64 is used for URLs, encode_url() and decode_url() should be used.
10//!
11//! 通常情况下，我们会用到 encode() 和 decode()。但如果 Base64 被用于 URL，那么就应该使用 encode_url() 和 decode_url()
12//!
13//! **encode**
14//!
15//! Given a string, return an encode result. This is the inverse of decode().
16//!
17//! **decode**
18//!
19//! Given a String, return a decode result, it's original of encode(). This is the inverse of decode().
20//!
21//! **encode_url**
22//!
23//! Like encode(), this is for url.
24//!
25//! **decode_url**
26//!
27//! Like decode(), this is for url
28//!
29//! # encode()
30//! &str to String, "Bruce Done say: Hi,I'm frank。" -> "QnJ1Y2UgRG9uZSBzYXk6IEhpLEknbSBmcmFua+OAgg=="
31//!
32//! Example
33//!
34//! use bases64::bases::Bases;
35//! let bases = Bases{};
36//! let res = bases.encode("Bruce Done say: Hi,I'm frank。");
37//! assert_eq!(res, String::from("QnJ1Y2UgRG9uZSBzYXk6IEhpLEknbSBmcmFua+OAgg=="));
38//!
39//! # decode()
40//!
41//! String to String, "QnJ1Y2UgRG9uZSBzYXk6IEhpLEknbSBmcmFua+OAgg==" -> "Bruce Done say: Hi,I'm frank。"
42//!
43//! Example
44//!
45//! use bases64::bases::Bases;
46//! let bases = Bases{};
47//! let res = bases.decode(String::from("QnJ1Y2UgRG9uZSBzYXk6IEhpLEknbSBmcmFua+OAgg=="));
48//! assert_eq!(res, String::from("Bruce Done say: Hi,I'm frank。"));
49//!
50//! # encode_url()
51//!
52//! For url.
53//!
54//! &str to String, "Bruce Done say: Hi,I'm frank。" -> "QnJ1Y2UgRG9uZSBzYXk6IEhpLEknbSBmcmFua-OAgg=="
55//!
56//! Example
57//!
58//! use bases64::bases::Bases;
59//! let bases = Bases{};
60//! let res = bases.encode_url("Bruce Done say: Hi,I'm frank。");
61//! assert_eq!(res, String::from("QnJ1Y2UgRG9uZSBzYXk6IEhpLEknbSBmcmFua-OAgg=="));
62//!
63//! # decode_url()
64//!
65//! For url.
66//!
67//! Example
68//!
69//! use bases64::bases::Bases;
70//! let bases = Bases{};
71//! let res = bases.decode_url(String::from("QnJ1Y2UgRG9uZSBzYXk6IEhpLEknbSBmcmFua-OAgg=="));
72//! assert_eq!(res, String::from("Bruce Done say: Hi,I'm frank。"));
73//!
74
75pub mod bases;
76
77