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 110 111 112 113 114 115 116 117 118 119 120
/*
==--==--==--==--==--==--==--==--==--==--==--==--==--==--==--==--
Perm
Copyright (C) 2021-2023 Anonymous
There are several releases over multiple years,
they are listed as ranges, such as: "2021-2023".
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/>.
::--::--::--::--::--::--::--::--::--::--::--::--::--::--::--::--
*/
//! # Perm
//!
//! ## 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 crate provides some help with [permutation iterators][struct:PermIter].
//!
//! ## Notes
//!
//! Documentation is built with all features. Some of them are optional. If you see components from other crates, you can view source to see
//! what features are required.
//!
//! [Semantic Versioning 2.0.0]: https://semver.org/spec/v2.0.0.html
//!
//! [struct:PermIter]: struct.PermIter.html
#![warn(missing_docs)]
#![no_std]
#![deny(unsafe_code)]
// ╔═════════════════╗
// ║ IDENTIFIERS ║
// ╚═════════════════╝
macro_rules! code_name { () => { "perm" }}
macro_rules! version { () => { "0.9.3" }}
/// # Crate name
pub const NAME: &str = "Perm";
/// # Crate code name
pub const CODE_NAME: &str = code_name!();
/// # ID of this crate
pub const ID: &str = concat!(
"82a0cbe8-506fc852-c5ad8157-2e8a9c11-34e63143-56c7ad76-590bcb58-a02494f9-",
"f4bdc8be-75ffcb1a-937b8407-ff87fe7a-0c953404-f37813a9-362516e2-4af955d2",
);
/// # Crate version
pub const VERSION: &str = version!();
/// # Crate release date (year/month/day)
pub const RELEASE_DATE: (u16, u8, u8) = (2023, 2, 14);
/// # Tag, which can be used for logging...
pub const TAG: &str = concat!(code_name!(), "::82a0cbe8::", version!());
// ╔════════════════════╗
// ║ IMPLEMENTATION ║
// ╚════════════════════╝
extern crate alloc;
#[cfg(feature="std")]
extern crate std;
/// # Wrapper for format!(), which prefixes your optional message with: crate::TAG, module_path!(), line!()
macro_rules! __ {
($($arg: tt)+) => {
alloc::format!(
"[{tag}][{module_path}-{line}] {msg}",
tag=crate::TAG, module_path=module_path!(), line=line!(), msg=alloc::format!($($arg)+),
)
};
() => {
alloc::format!("[{tag}][{module_path}-{line}] (internal error)", tag=crate::TAG, module_path=module_path!(), line=line!())
};
}
mod buffer;
mod data;
mod error;
mod perm_iter;
pub mod version_info;
pub use self::{
buffer::*,
error::*,
perm_iter::*,
};
/// # Result type used in this crate
pub type Result<T> = core::result::Result<T, Error>;
#[test]
fn test_crate_version() {
assert_eq!(VERSION, env!("CARGO_PKG_VERSION"));
}