bases64/lib.rs
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
//! The bases crate base on RFC4648
//!
//! bases 库是基于规范文档 RFC4648 编写的库
//!
//! This crate is very simple
//!
//! 这个库非常简单易用
//!
//! Usually, we use encode () and decode (). But if Base64 is used for URLs, encode_url() and decode_url() should be used.
//!
//! 通常情况下,我们会用到 encode() 和 decode()。但如果 Base64 被用于 URL,那么就应该使用 encode_url() 和 decode_url()
//!
//! **encode**
//!
//! Given a string, return an encode result. This is the inverse of decode().
//!
//! **decode**
//!
//! Given a String, return a decode result, it's original of encode(). This is the inverse of decode().
//!
//! **encode_url**
//!
//! Like encode(), this is for url.
//!
//! **decode_url**
//!
//! Like decode(), this is for url
//!
//! # encode()
//! &str to String, "Bruce Done say: Hi,I'm frank。" -> "QnJ1Y2UgRG9uZSBzYXk6IEhpLEknbSBmcmFua+OAgg=="
//!
//! Example
//!
//! use bases64::bases::Bases;
//! let bases = Bases{};
//! let res = bases.encode("Bruce Done say: Hi,I'm frank。");
//! assert_eq!(res, String::from("QnJ1Y2UgRG9uZSBzYXk6IEhpLEknbSBmcmFua+OAgg=="));
//!
//! # decode()
//!
//! String to String, "QnJ1Y2UgRG9uZSBzYXk6IEhpLEknbSBmcmFua+OAgg==" -> "Bruce Done say: Hi,I'm frank。"
//!
//! Example
//!
//! use bases64::bases::Bases;
//! let bases = Bases{};
//! let res = bases.decode(String::from("QnJ1Y2UgRG9uZSBzYXk6IEhpLEknbSBmcmFua+OAgg=="));
//! assert_eq!(res, String::from("Bruce Done say: Hi,I'm frank。"));
//!
//! # encode_url()
//!
//! For url.
//!
//! &str to String, "Bruce Done say: Hi,I'm frank。" -> "QnJ1Y2UgRG9uZSBzYXk6IEhpLEknbSBmcmFua-OAgg=="
//!
//! Example
//!
//! use bases64::bases::Bases;
//! let bases = Bases{};
//! let res = bases.encode_url("Bruce Done say: Hi,I'm frank。");
//! assert_eq!(res, String::from("QnJ1Y2UgRG9uZSBzYXk6IEhpLEknbSBmcmFua-OAgg=="));
//!
//! # decode_url()
//!
//! For url.
//!
//! Example
//!
//! use bases64::bases::Bases;
//! let bases = Bases{};
//! let res = bases.decode_url(String::from("QnJ1Y2UgRG9uZSBzYXk6IEhpLEknbSBmcmFua-OAgg=="));
//! assert_eq!(res, String::from("Bruce Done say: Hi,I'm frank。"));
//!
pub mod bases;