Struct MutDoc 

pub struct MutDoc {
    pub doc_id: String,
    pub path: String,
    pub format: String,
    pub leading_trivia: String,
    pub frontmatter_raw: Option<String>,
    pub children: Vec<MutBlock>,
}

A document in the working tree (§1 MutDoc).

Fields

doc_id: String

path: String

format: String

docs.format (markdown).

leading_trivia: String

docs.leading_trivia.

frontmatter_raw: Option<String>

The current revision’s frontmatter blob + docs.frontmatter_trivia, or None when the document has no frontmatter.

children: Vec<MutBlock>

The top-level blocks.

Implementations

impl MutDoc

The six ops as methods (two-phase borrows let a caller compute ids from the document inside the argument list).

pub fn insert( &mut self, to: &To, markdown: &str, minter: &mut dyn Minter, ) -> Result<OpResult, MutationError>

op_insert without the §1.2 order CAS (op_index 0).

pub fn update( &mut self, block_id: &str, op_index: usize, args: &UpdateArgs, minter: &mut dyn Minter, ) -> Result<OpResult, MutationError>

op_update.

pub fn move_blocks( &mut self, block_ids: &[String], to: &To, op_index: usize, ) -> Result<OpResult, MutationError>

op_move without the §1.2 order CAS.

pub fn remove( &mut self, block_ids: &[String], op_index: usize, expect_per: Option<&BTreeMap<String, Expect>>, ) -> Result<OpResult, MutationError>

op_remove.

pub fn split( &mut self, block_id: &str, at: &[usize], op_index: usize, expect: Option<&Expect>, minter: &mut dyn Minter, ) -> Result<OpResult, MutationError>

op_split.

pub fn merge( &mut self, block_ids: &[String], op_index: usize, separator: Option<&str>, expect_per: Option<&BTreeMap<String, Expect>>, ) -> Result<OpResult, MutationError>

op_merge.

impl MutDoc

pub fn new(doc_id: &str, path: &str, children: Vec<MutBlock>) -> MutDoc

A document with no frontmatter and the given top-level blocks.

pub fn iter(&self) -> impl Iterator<Item = &MutBlock>

Every block at every depth, pre-order.

pub fn locate(&self, block_id: &str) -> Option<Vec<usize>>

§1: find a block anywhere in the document; its path.

pub fn contains(&self, block_id: &str) -> bool

Whether block_id is anywhere in the document.

pub fn siblings(&self, parent: &[usize]) -> &Vec<MutBlock>

The sibling list a parent path names ([] → the top level).

pub fn siblings_mut(&mut self, parent: &[usize]) -> &mut Vec<MutBlock>

Mutable MutDoc::siblings.

pub fn block(&self, path: &[usize]) -> &MutBlock

The block at path.

Panics

If path is empty or does not name a block.

pub fn block_mut(&mut self, path: &[usize]) -> &mut MutBlock

Mutable MutDoc::block.

Panics

If path is empty or does not name a block.

pub fn owner_of(&self, parent: &[usize]) -> Option<&MutBlock>

§1 owner_of: the block owning the sibling list at parent, or None at the top level.

pub fn mark_container_dirty(&mut self, parent: &[usize])

§1 mark_container_dirty: a structural change to a sibling list invalidates its owner’s raw; the top level needs no marking.

pub fn all_ids(&self) -> Vec<String>

The ids of every block, pre-order.

Trait Implementations

impl Clone for MutDoc

fn clone(&self) -> MutDoc

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MutDoc

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

Formats the value using the given formatter.

impl PartialEq for MutDoc

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for MutDoc