Struct yarner_lib::Document

pub struct Document {
    pub nodes: Vec<Node>,
    pub newline: String,
}

A representation of a Document of literate code

Fields

nodes: Vec<Node>

The nodes forming the document

newline: String

The newline character(s) used in the sources

Implementations

impl Document

pub fn new(nodes: Vec<Node>, newline: String) -> Self

Creates a new document with the given nodes

pub fn newline(&self) -> &str

The newline character(s) used in the sources

pub fn code_blocks(&self) -> impl Iterator<Item = &CodeBlock>

Gets all the code blocks of this document

pub fn code_blocks_by_name(&self) -> HashMap<Option<&str>, Vec<&CodeBlock>>

Code blocks, mapped by name

pub fn transclusions(&self) -> impl Iterator<Item = &Transclusion>

Gets all the transclusions of this document

pub fn entry_points(&self) -> HashMap<Option<&str>, (&Path, Option<PathBuf>)>

Finds all file-specific entry points

Trait Implementations

impl Debug for Document

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Document

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Serialize for Document

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.