PTV/radn-rs
1
1
Fork 0
Code Issues 3 Pull Requests Packages Projects Releases Wiki Activity

InliningAtomic docs

Browse Source
This commit is contained in:
AF 2023-07-30 20:27:24 +00:00
parent 96018d80dd
commit 2c22dd690f
1 changed files with 8 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
src/atomic/inlining.rs
View File

@ -1,20 +1,27 @@
pub use super::*;
/// Inlining version of [`AParseResult`]. Preserves the parser.
pub type AIParseResult<A, I> = Result<(A, I), AParseError<A>>;
/// For auto-deriving [`InliningAtomic`] from concrete implementations.
pub trait CInliningAtomic: AtomicBase + ImplMode<Mode = InliningMode> {
/// Concrete implementation of [`InliningAtomic::a_extension_error`].
fn ca_extension_error(tail: &[u8]) -> Self::AParseError;
/// Concrete implementation of [`InliningAtomic::a_ideserialize`].
fn ca_ideserialize<I: Stream>(stream: I) -> AIParseResult<Self, I>;
}
/// Atomic analogue of [`InliningFactory`]/[`InliningObject`].
/// [`Atomic`] analogue of [`InliningFactory`]/[`InliningObject`].
///
/// [`InliningFactory`]: crate::rcore::InliningFactory
/// [`InliningObject`]: crate::rstd::inlining::InliningObject
pub trait InliningAtomic: AtomicBase + ParseMode<Mode = InliningMode> {
/// Always fail on extension,
/// as parsing of an inlining atomic should be determined without reaching EOF.
fn a_extension_error(tail: &[u8]) -> Self::AParseError;
/// Inlining version of [`Atomic::a_deserialize`]. Preserves the parser.
fn a_ideserialize<I: Stream>(strean: I) -> AIParseResult<Self, I>;
}