Struct Library 

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

A parsed BibTeX library.

Implementations

impl<'a> Library<'a>

pub fn new() -> Self

Create a new empty library

pub fn parser() -> Parser

Create a parser with options

Parallel Processing

The threads option only affects parse_files(). Single file parsing with parse() is sequential.

Example

use bibtex_parser::Library;
// Parse multiple files in parallel
let library = Library::parser()
    .threads(4)
    .parse_files(&["file1.bib", "file2.bib"]).unwrap();

// Single-file parsing stays sequential
let content = "@article{demo, title=\"Demo\"}";
let library = Library::parser()
    .threads(4)
    .parse(content).unwrap();

pub fn parse(input: &'a str) -> Result<Self>

Parse a BibTeX library from a string with default strict settings.

pub fn parse_file(path: impl AsRef<Path>) -> Result<Library<'static>>

Parse a BibTeX library from a file into owned data.

pub fn to_bibtex(&self) -> Result<String>

Serialize this library to BibTeX.

pub fn write_file(&self, path: impl AsRef<Path>) -> Result<()>

Serialize this library to a BibTeX file.

pub fn merge(&mut self, other: Self)

Merge another library into this one

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

Get all entries

pub fn entries_mut(&mut self) -> &mut Vec<Entry<'a>>

Get mutable access to all entries

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

Get all string definitions

pub fn string(&self, name: &str) -> Option<&StringDefinition<'a>>

Get a string definition by name.

pub fn string_value(&self, name: &str) -> Option<&Value<'a>>

Get a string definition value by name.

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

Get all preambles

pub fn preambles_mut(&mut self) -> &mut Vec<Preamble<'a>>

Get mutable access to preambles

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

Get all comments

pub fn comments_mut(&mut self) -> &mut Vec<Comment<'a>>

Get mutable access to comments

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

Get malformed blocks retained by tolerant parsing.

pub fn blocks(&self) -> Vec<Block<'_, 'a>>

Return blocks in source order.

pub fn find_by_key(&self, key: &str) -> Option<&Entry<'a>>

Find entries by key

pub fn find_by_key_ignore_case(&self, key: &str) -> Option<&Entry<'a>>

Find entries by key, ignoring ASCII case.

pub fn contains_key(&self, key: &str) -> bool

Return true when the library contains key.

pub fn find_by_type(&self, ty: &str) -> Vec<&Entry<'a>>

Find entries by type

pub fn find_by_field(&self, field: &str, value: &str) -> Vec<&Entry<'a>>

Find entries by field value

pub fn find_by_field_ignore_case( &self, field: &str, value: &str, ) -> Vec<&Entry<'a>>

Find entries by field value, ignoring ASCII case for the field name and value.

pub fn find_by_doi(&self, doi: &str) -> Vec<&Entry<'a>>

Find entries whose normalized DOI matches doi.

pub fn expand_value_ref(&self, value: &Value<'a>) -> Result<Value<'a>>

Alternative expansion that works with references (requires cloning for variables)

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

Get a fully expanded string value.

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

Convert to owned version (no borrowed data)

pub fn add_string(&mut self, name: &'a str, value: Value<'a>)

Add a string definition (useful for building libraries programmatically)

pub fn add_entry(&mut self, entry: Entry<'a>)

Add an entry

pub fn add_preamble(&mut self, value: Value<'a>)

Add a preamble

pub fn add_comment(&mut self, comment: &'a str)

Add a comment

pub fn resolve_strings(&mut self) -> Result<()>

Resolve string variables and concatenations in entries and preambles in place.

pub fn normalize_doi_fields(&mut self)

Normalize DOI fields to lowercase 10.x/... form when recognizable.

pub fn normalize_months(&mut self, style: MonthStyle)

Normalize month fields to a chosen representation.

pub fn normalize_fields(&mut self, options: FieldNormalizeOptions)

Normalize field names and common BibLaTeX aliases.

pub fn sort(&mut self, options: SortOptions)

Sort entries and/or fields in place.

pub fn validate( &self, level: ValidationLevel, ) -> Vec<(usize, &Entry<'a>, Vec<ValidationError>)>

Validate all entries in the library Returns a list of entries with their indices and validation errors

pub fn find_duplicate_keys(&self) -> Vec<&str>

Check for duplicate citation keys Returns a list of duplicate keys (each key appears once in the list even if it has multiple duplicates)

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

Check for duplicate citation keys, ignoring ASCII case.

pub fn find_duplicate_dois(&self) -> Vec<(String, Vec<&Entry<'a>>)>

Find duplicate DOI groups using normalized DOI values.

pub fn validate_comprehensive( &self, level: ValidationLevel, ) -> ValidationReport<'_>

Validate all entries and return a comprehensive validation report

pub fn stats(&self) -> LibraryStats

Get statistics about the library

Trait Implementations

impl<'a> Clone for Library<'a>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Library<'a>

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

Formats the value using the given formatter.

impl<'a> Default for Library<'a>

fn default() -> Library<'a>

Returns the “default value” for a type.