pub struct ConstructDoc {
pub name: &'static str,
pub what: &'static str,
pub example: &'static str,
pub question_or_tip: &'static str,
pub guide_anchor: Option<&'static str>,
}Expand description
A complete lesson for one construct. Every field is required by the TYPE — an entry cannot exist without a plain sentence, a runnable example, and a socratic question or tip. Clear-and-easy is structural, not aspirational.
Fields§
§name: &'static strThe construct’s display name (“Give”, “Main”, “Seq”).
what: &'static strONE plain sentence: what it does. Kept under 90 characters by the teach lock — if it needs more, the rest belongs in the question/tip.
example: &'static strA runnable snippet (code-block body, no fences). Must lex.
question_or_tip: &'static strThe socratic seat: a guiding question (contains ?) or an explicit
Tip: — it leads the reader to the next insight, never just restates.
guide_anchor: Option<&'static str>A LOGOS_QUICKGUIDE.md heading slug for “read more”, when one fits.
Auto Trait Implementations§
impl Freeze for ConstructDoc
impl RefUnwindSafe for ConstructDoc
impl Send for ConstructDoc
impl Sync for ConstructDoc
impl Unpin for ConstructDoc
impl UnsafeUnpin for ConstructDoc
impl UnwindSafe for ConstructDoc
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more