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
/*
==--==--==--==--==--==--==--==--==--==--==--==--==--==--==--==--
Bi
Copyright (C) 2019, 2021-2022, 2024 Anonymous
There are several releases over multiple years,
they are listed as ranges, such as: "2021-2022".
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
::--::--::--::--::--::--::--::--::--::--::--::--::--::--::--::--
*/
//! # Bi
//!
//! ## Project
//!
//! - License: GNU Lesser General Public License, either version 3, or (at your option) any later version.
//! - _This project follows [Semantic Versioning 2.0.0]_
//!
//! ## Features
//!
//! This project helps with controlling multiple tasks reading data into memory.
//!
//! For examples, see [`Bi`][struct:Bi].
//!
//! [Semantic Versioning 2.0.0]: https://semver.org/spec/v2.0.0.html
//!
//! [struct:Bi]: struct.Bi.html
#![warn(missing_docs)]
// ╔═════════════════╗
// ║ IDENTIFIERS ║
// ╚═════════════════╝
macro_rules! code_name { () => { "bi" }}
macro_rules! version { () => { "0.11.0" }}
/// # Crate name
pub const NAME: &str = "Bi";
/// # Crate code name
pub const CODE_NAME: &str = code_name!();
/// # ID of this crate
pub const ID: &str = concat!(
"00379f52-dfadbc00-3da8f57a-f716404e-5065e0aa-ee581855-d90ac217-1e2435f6-",
"f85f4d8f-192af866-cfb5b5c5-5ccfee4e-09aa0f75-209a9807-b6b1d5a9-ef611134",
);
/// # Crate version
pub const VERSION: &str = version!();
/// # Crate release date (year/month/day)
pub const RELEASE_DATE: (u16, u8, u8) = (2024, 3, 9);
/// # Tag, which can be used for logging...
pub const TAG: &str = concat!(code_name!(), "::00379f52::", version!());
// ╔════════════════════╗
// ║ IMPLEMENTATION ║
// ╚════════════════════╝
/// # Wrapper for format!(), which prefixes your optional message with: crate::TAG, module_path!(), line!()
macro_rules! __ {
($($arg: tt)+) => {
format!("[{tag}][{module_path}-{line}] {msg}", tag=crate::TAG, module_path=module_path!(), line=line!(), msg=format!($($arg)+))
};
() => {
format!("[{tag}][{module_path}-{line}] (internal error)", tag=crate::TAG, module_path=module_path!(), line=line!())
};
}
mod bi;
mod bytes;
mod counter;
mod options;
pub use crate::{
bi::*,
bytes::*,
options::*,
};
pub (crate) use crate::counter::*;
pub mod version_info;
/// # Result type used in this crate
pub type IoResult<T> = core::result::Result<T, std::io::Error>;
#[test]
fn test_crate_version() {
assert_eq!(VERSION, env!("CARGO_PKG_VERSION"));
}