Struct GuideEntry 

pub struct GuideEntry {
    pub name: String,
    pub summary: String,
    pub content: String,
}

Parsed guide document.

Fields

name: String

Topic name, usually the markdown filename without .md.

summary: String

One-line summary from front matter.

content: String

Markdown body without front matter.

Implementations

impl GuideEntry

pub fn new( name: impl Into<String>, summary: impl Into<String>, content: impl Into<String>, ) -> Self

Creates a guide entry from explicit topic metadata and markdown content.

pub fn from_markdown_path(path: &str, content: &str) -> Self

Parses a guide entry from a markdown path and content.

Trait Implementations

impl Clone for GuideEntry

fn clone(&self) -> GuideEntry

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GuideEntry

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for GuideEntry

impl PartialEq for GuideEntry

fn eq(&self, other: &GuideEntry) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for GuideEntry