Struct Document 

pub struct Document { /* private fields */ }

A markdown document as its editors share it.

Implementations

impl Document

pub fn new(source: &str, cx: &mut Context<'_, Self>) -> Self

pub fn with_undo_limit(self, limit: usize) -> Self

How many undo steps to keep; crate::DEFAULT_UNDO_LIMIT until set. A run of typing coalesces into one step.

pub fn with_marks(self, marks: Marks) -> Self

Read and write this document with marks of its own, rather than the ones markdown::AppExt::set_marks installed. For an app whose documents do not all speak the same dialect.

pub fn with_mode(self, mode: Mode) -> Self

Open in Mode::Source rather than on the document — an app whose document is a markdown file first. Nothing is recorded: this is where the document starts, not a switch to step back over.

pub fn source(&self) -> String

The document as markdown — see crate::Editor::source.

pub fn mode(&self) -> Mode

Which form the document is being edited in.

pub fn doc(&self) -> &Doc

pub fn reload(&mut self, source: &str, cx: &mut Context<'_, Self>)

Read the document again from source, in the form it is in. The undo stack and the anchors go with the old text.

pub fn anchors(&self) -> &[Anchor]

The comment ranges, mapped up to date with the document.

A range that reads Anchor::detached lost the words it pointed at. It is kept rather than dropped, because whether that means “outdated” or “resolved” is the app’s question.

pub fn set_anchors(&mut self, anchors: Vec<Anchor>, cx: &mut Context<'_, Self>)

Hand over the whole list — the app keeps the threads, this keeps their ranges. One entry point rather than add/remove/update, since the app is already holding the list that decides all three.

Ranges are positions in Self::doc as it stands: the source fence in Mode::Source, the blocks otherwise.

pub fn source_with_anchors(&self) -> (String, SourceRanges)

The markdown to save, and where each anchor’s ends land in it, in byte offsets, in the order of Self::anchors. A range with an end the markdown has no place for comes out None.

The string is Self::source but for whitespace a placed end keeps from being trailing; the ranges index this string, so it is the one to write beside them.

pub fn set_source_anchors( &mut self, source: &str, anchors: Vec<SourceAnchor>, cx: &mut Context<'_, Self>, )

Self::set_anchors with ranges given in byte offsets into source, the markdown the document was read from. A range with an end the document has no place for comes in detached.

Trait Implementations

impl EventEmitter<DocumentEvent> for Document