Struct File 

pub struct File {
    pub path: Option<String>,
    pub value: Option<String>,
    pub messages: Vec<Message>,
    pub data: Map<String, Value>,
}

The document a pipeline processes: where it came from and what plugins reported about it.

Fields

path: Option<String>

value: Option<String>

The text the tree was parsed from, which byte spans point into.

messages: Vec<Message>

data: Map<String, Value>

What plugins store for whoever reads the result, as vfile’s data holds it.

Implementations

impl File

pub fn new() -> Self

pub fn warn(&mut self, reason: impl Into<String>, rule: Option<&str>)

Record a warning against the file.

Trait Implementations

impl Clone for File

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 File

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

Formats the value using the given formatter.

impl Default for File

fn default() -> Self

Returns the “default value” for a type.