From c9287c97d424d53500247fa8560a5762945450cb Mon Sep 17 00:00:00 2001 From: timofey Date: Sun, 30 Jul 2023 17:08:57 +0000 Subject: [PATCH] "Base"s docs --- src/rcore.rs | 3 ++- src/rstd/atomic.rs | 7 ++++--- 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/src/rcore.rs b/src/rcore.rs index c2f4ee6..609d06a 100644 --- a/src/rcore.rs +++ b/src/rcore.rs @@ -51,7 +51,7 @@ pub use self::slice_deserializer::SliceDeserializer; /// Helper alias for [`WeakFunctor::F`] of [`FunctorContext::T`]. pub type Wrapped<'a, Ctx, A> = WrapC<'a, A, Ctx>; -/// Fundamental trait for ADN objects. +/// Base for [`Mentionable`]. pub trait MentionableBase<'a, Ctx: Context<'a>>: 'a + Serializable + Sized { /// Type of the associated factory. type Fctr: FactoryBase<'a, Ctx, Mtbl = Self>; @@ -78,6 +78,7 @@ pub trait MentionableTop<'a, Ctx: Context<'a>>: 'a { Self: Mentionable<'a, Ctx>; } +/// Fundamental trait for ADN objects. pub trait Mentionable<'a, Ctx: Context<'a>>: MentionableBase<'a, Ctx, Fctr = Self::_Fctr> + MentionableTop<'a, Ctx> { diff --git a/src/rstd/atomic.rs b/src/rstd/atomic.rs index 118ffc0..397b974 100644 --- a/src/rstd/atomic.rs +++ b/src/rstd/atomic.rs @@ -24,14 +24,15 @@ pub type AParseError = ::AParseError; pub type AParseResult = Result>; -/// This trait combines functionality of [`Mentionable`] and [`Factory`], -/// while limiting [`MentionableTop::points_typed`] (and corresponding [`MentionableTop::topology`]) -/// to an empty sequence. +/// Base for [`Atomic`]. pub trait AtomicBase: 'static + Send + Sync + Send + Clone + Serializable { /// Equivalent of [`FactoryBase::ParseError`]. type AParseError: Error; } +/// This trait combines functionality of [`Mentionable`] and [`Factory`], +/// while limiting [`MentionableTop::points_typed`] (and corresponding [`MentionableTop::topology`]) +/// to an empty sequence. pub trait Atomic: AtomicBase + ParseMode { /// Static equivalent of [`FactoryParse::deserialize`]. fn a_deserialize(inlining: impl Inlining) -> AParseResult;