Struct ParsedDocument 

pub struct ParsedDocument<'a> { /* private fields */ }

Rich parsed document for tooling-grade bibliography workflows.

Implementations

impl<'a> ParsedDocument<'a>

pub fn from_library(library: Library<'a>) -> Self

Build a parsed document from the existing structured library model.

pub const fn library(&self) -> &Library<'a>

Return the compact structured library view.

pub fn into_library(self) -> Library<'a>

Consume this document and return the compact structured library view.

pub fn sources(&self) -> &[ParsedSource<'a>]

Return source metadata.

pub fn entries(&self) -> &[ParsedEntry<'a>]

Return parsed entries.

pub fn entries_mut(&mut self) -> &mut [ParsedEntry<'a>]

Return mutable parsed entries.

pub fn entry_mut_by_key(&mut self, key: &str) -> Option<&mut ParsedEntry<'a>>

Return a mutable entry by citation key.

pub fn rename_key(&mut self, old: &str, new: impl Into<Cow<'a, str>>) -> bool

Rename a citation key.

pub fn remove_export_fields(&mut self, names: &[&str]) -> usize

Remove configured export-only fields from all entries.

pub fn strings(&self) -> &[ParsedString<'a>]

Return parsed string definitions.

pub fn preambles(&self) -> &[ParsedPreamble<'a>]

Return parsed preambles.

pub fn comments(&self) -> &[ParsedComment<'a>]

Return parsed comments.

pub fn failed_blocks(&self) -> &[ParsedFailedBlock<'a>]

Return failed blocks retained by tolerant parsing.

pub fn blocks(&self) -> &[ParsedBlock]

Return source-order blocks.

pub fn diagnostics(&self) -> &[Diagnostic]

Return document diagnostics.

pub const fn status(&self) -> ParseStatus

Return the document parse status.

pub fn summary(&self) -> ParseSummary

Return summary counts for the parsed document.

pub fn expand_value( &self, value: &Value<'a>, options: ExpansionOptions, ) -> Result<String>

Expand a parsed value using this document’s string definitions.

This allocates the expanded text. The structured value itself remains unchanged, and unresolved-variable behavior follows options.

pub fn into_owned(self) -> ParsedDocument<'static>

Convert this parsed document into an owned value.

Trait Implementations

impl<'a> Clone for ParsedDocument<'a>

fn clone(&self) -> ParsedDocument<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for ParsedDocument<'a>

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

Formats the value using the given formatter.