istate docs

This commit is contained in:
AF 2023-04-25 15:03:20 +00:00
parent 68bce93ede
commit 4d6cfaac1c
3 changed files with 11 additions and 2 deletions

View File

@ -1,3 +1,3 @@
//! Data structures and algorithms, independent of [crate::core] concepts.
//! Data structures and algorithms, independent of [`crate::core`] concepts.
pub mod traversible;

View File

@ -1,10 +1,16 @@
use super::*;
/// Represents iteration state.
/// Represents iteration state. Used in [`Monad::ibind`].
///
/// [`IState<P, D>`] is isomorphic to [`Result<D, P>`].
pub enum IState<P, D> {
/// Loop running.
///
/// Isomorphic to [`Result::Err`].
Pending(P),
/// Loop finished.
///
/// Isomorphic to [`Result::Ok`].
Done(D),
}

View File

@ -1,3 +1,6 @@
//! # RADN
//! Rainbow something something Network.
pub mod core;
pub mod flow;
pub mod func;