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
// License: see LICENSE file at root directory of `master` branch //! # An implementation of Base64 - <https://en.wikipedia.org/wiki/Base64> //! //! # Project //! //! - Repository: <https://bitbucket.org/haibison/debt64> //! - License: Nice License 1.0.0 _(see LICENSE file at root directory of `master` branch)_ //! - _This project follows [Semantic Versioning 2.0.0]_ //! //! --- //! //! # Features //! //! ## No debts (no dependencies) //! //! When introducing the first iPhone, Mr. Steve Jobs had a famous line about the stylus. Thanks to young people writing a·ma·teur crates, I //! have a chance to borrow his line here: //! //! > _Debts, who uses debts? Yuck! Let's not use debts._ //! //! And here is my own line: It's a tiny implementation, so let's not use debts! //! //! # Notes //! //! The crate uses `#![no_std]` by default. Documentation is built with all features, which include `std`. If you see some components from //! [`std`][crate:std] crate, you have to use that feature. //! //! # Panics //! //! Panics are our failure. It would help us a lot if you file new issues when you encounter panics. //! //! [Semantic Versioning 2.0.0]: https://semver.org/spec/v2.0.0.html //! [crate:std]: https://doc.rust-lang.org/std/ #![warn(missing_docs)] #![no_std] // ╔═════════════════╗ // ║ IDENTIFIERS ║ // ╚═════════════════╝ macro_rules! code_name { () => { "debt64" }} macro_rules! version { () => { "3.1.0" }} /// # Crate name pub const NAME: &str = "Debt64"; /// # Crate code name pub const CODE_NAME: &str = code_name!(); /// # ID of this crate pub const ID: &str = concat!( "c5fc1319-537de2ff-3391c249-27d889aa-73d02054-066be161-dfd4b45d-5539d223-", "793e7cbb-8bb5876f-bde37717-632c413f-f5ca19ed-862861b5-dc0bea06-73743fb4", ); /// # Crate version pub const VERSION: &str = version!(); /// # Crate release date (year/month/day) pub const RELEASE_DATE: (u16, u8, u8) = (2019, 8, 14); /// # Tag, which can be used for logging... pub const TAG: &str = concat!(code_name!(), "::c5fc1319::", version!()); // ╔════════════════════╗ // ║ IMPLEMENTATION ║ // ╚════════════════════╝ extern crate alloc; #[cfg(feature="std")] extern crate std; mod error; mod root; pub use crate::{ error::*, root::*, }; pub mod version_info; /// # Result type used in this crate pub type Result<'a, T> = core::result::Result<T, ReadOnlyError<'a>>; #[test] fn test_crate_version() { assert_eq!(VERSION, env!("CARGO_PKG_VERSION")); }