Struct Document 

pub struct Document {
    pub node: Node,
    pub label: Option<String>,
    pub highlights: Vec<(Path, Style)>,
}

A data tree on its way to being rendered, with what transforms decided about how to show it.

Fields

node: Node

label: Option<String>

The root’s label: the file name, or the path Select narrowed to.

highlights: Vec<(Path, Style)>

Styles for the lines of these paths, from Highlight.

Implementations

impl Document

pub fn new(node: Node) -> Self

pub fn label(self, label: impl Into<String>) -> Self

pub fn explorer(&self) -> Explorer<'_>

An Explorer over the document, with its label and highlights.

Trait Implementations

impl Clone for Document

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Document

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

Formats the value using the given formatter.

impl PartialEq for Document

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Document

impl<R: Redactor + Send + Sync> Transform<Document> for Redact<R>

fn apply(&self, document: Document) -> Result<Document, TransformError>

impl Transform<Document> for Select

fn apply(&self, document: Document) -> Result<Document, TransformError>

impl Transform<Document> for Filter

fn apply(&self, document: Document) -> Result<Document, TransformError>

impl Transform<Document> for Highlight

fn apply(&self, document: Document) -> Result<Document, TransformError>