mirror of
https://github.com/Cuprate/cuprate.git
synced 2025-01-22 10:44:36 +00:00
4b93dbec4c
Some checks failed
CI / fmt (push) Waiting to run
CI / typo (push) Waiting to run
CI / ci (macos-latest, stable, bash) (push) Waiting to run
CI / ci (ubuntu-latest, stable, bash) (push) Waiting to run
CI / ci (windows-latest, stable-x86_64-pc-windows-gnu, msys2 {0}) (push) Waiting to run
Audit / audit (push) Has been cancelled
Deny / audit (push) Has been cancelled
* rename all directories and crates * fix all `use` * fix doc link * `dandelion/` -> `dandelion-tower/` * fix epee-encoding test * fix `json-rpc` * fix pruning * crate import fixes * fix leftover merge conflicts * fix `epee-encoding`
33 lines
1.3 KiB
Rust
33 lines
1.3 KiB
Rust
//! Macros.
|
|
//!
|
|
//! These generate repetitive documentation
|
|
//! for all the functions defined in `ops/`.
|
|
|
|
//---------------------------------------------------------------------------------------------------- Documentation macros
|
|
/// Generate documentation for the required `# Error` section.
|
|
macro_rules! doc_error {
|
|
() => {
|
|
r#"# Errors
|
|
This function returns [`RuntimeError::KeyNotFound`] if the input (if applicable) doesn't exist or other `RuntimeError`'s on database errors."#
|
|
};
|
|
}
|
|
pub(super) use doc_error;
|
|
|
|
/// Generate `# Invariant` documentation for internal `fn`'s
|
|
/// that should be called directly with caution.
|
|
macro_rules! doc_add_block_inner_invariant {
|
|
() => {
|
|
r#"# ⚠️ Invariant ⚠️
|
|
This function mainly exists to be used internally by the parent function [`crate::ops::block::add_block`].
|
|
|
|
`add_block()` makes sure all data related to the input is mutated, while
|
|
this function _does not_, it specifically mutates _particular_ tables.
|
|
|
|
This is usually undesired - although this function is still available to call directly.
|
|
|
|
When calling this function, ensure that either:
|
|
1. This effect (incomplete database mutation) is what is desired, or that...
|
|
2. ...the other tables will also be mutated to a correct state"#
|
|
};
|
|
}
|
|
pub(super) use doc_add_block_inner_invariant;
|