Struct markdown_extract::document::Section

pub struct Section {
    pub level: u8,
    pub title: String,
    pub body: String,
    pub parent: Option<usize>,
    pub children: Vec<usize>,
}

A section within a markdown document

Fields

level: u8

Section depth. In markdown, legal values range from 1 to 6, although this implementation technically allows more.

title: String

Title of section

body: String

Raw markdown body. Does not include any child sections. See the children property for child content.

parent: Option<usize>

An optional pointer to a parent section. This property should always be Some, unless the section is located at the root of the document.

children: Vec<usize>

A vector of child sections

Methods

impl Section

pub fn new() -> Section

Construct a new section

pub fn append_to_body(&mut self, line: String)

Appends the given line to the section's body

pub fn add_child(&mut self, child: usize)

Add a child to this section.

Trait Implementations

impl Clone for Section

fn clone(&self) -> Section

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Section

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

Formats the value using the given formatter.