diff --git a/src/mode.rs b/src/mode.rs index 9bb4d1d..5c9890b 100644 --- a/src/mode.rs +++ b/src/mode.rs @@ -1,4 +1,16 @@ //! [`Mode`]-based parsing. +//! +//! | [`Mode`] | [`Factory`] | [`Atomic`] | +//! |------------------|---------------------|--------------------| +//! | [`RegularMode`] | [`RegularFactory`] | [`RegularAtomic`] | +//! | [`InliningMode`] | [`InliningFactory`] | [`InliningAtomic`] | +//! +//! [`Factory`]: crate::rcore::Factory +//! [`Atomic`]: crate::atomic::Atomic +//! [`RegularFactory`]: crate::rcore::RegularFactory +//! [`RegularAtomic`]: crate::atomic::RegularAtomic +//! [`InliningFactory`]: crate::rcore::InliningFactory +//! [`InliningAtomic`]: crate::atomic::InliningAtomic mod inlining; mod regular; @@ -32,13 +44,16 @@ pub type ModeResult = Result, E>; /// Mode of parsing. /// -/// | [`Mode`] | [`Mode::ParseSuccess`] | [`Mode::ExtensionResult`] | [`Mode::ExtensionSource`] | -/// |------------------|------------------------------|---------------------------------|------------------------------| -/// | [`RegularMode`] | `A` | [`Result`] | `A` | -/// | [`InliningMode`] | [`(A, I)`] | `E` | [`()`] | +/// | [`Mode`] | [`ParseSuccess`] | [`ExtensionResult`] | [`ExtensionSource`] | +/// |------------------|------------------------|---------------------------|------------------------| +/// | [`RegularMode`] | `A` | [`Result`] | `A` | +/// | [`InliningMode`] | [`(A, I)`] | `E` | [`()`] | /// /// [`(A, I)`]: tuple /// [`()`]: unit +/// [`ParseSuccess`]: Mode::ParseSuccess +/// [`ExtensionResult`]: Mode::ExtensionResult +/// [`ExtensionSource`]: Mode::ExtensionSource pub trait Mode { /// Successful parsing, may contain the parser itself /// (`I`, usually [`Stream`]).