Struct PlanDocument 

pub struct PlanDocument {
    pub path: String,
    pub lines: Vec<PlanSourceLine>,
    pub outline: Vec<PlanSection>,
}

Fields

path: String

lines: Vec<PlanSourceLine>

outline: Vec<PlanSection>

Implementations

impl PlanDocument

pub fn parse(path: impl Into<String>, markdown: &str) -> Self

pub fn section_title_for(&self, line: &PlanSourceLine) -> Option<&str>

pub fn markdown_text(&self) -> String

pub fn line_count(&self) -> usize

pub fn line_by_no(&self, line_no: usize) -> Option<&PlanSourceLine>

Trait Implementations

impl Clone for PlanDocument

fn clone(&self) -> PlanDocument

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PlanDocument

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

Formats the value using the given formatter.

impl PartialEq for PlanDocument

fn eq(&self, other: &PlanDocument) -> 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 Eq for PlanDocument

impl StructuralPartialEq for PlanDocument