Struct biblatex::Bibliography

pub struct Bibliography { /* fields omitted */ }

A fully parsed bibliography.

Implementations

impl Bibliography

pub fn new() -> Self

Get a new, empty Bibliography

pub fn from_str(src: &str, allow_bibtex: bool) -> Self

Parse a bibliography from a source string.

pub fn from_raw(raw: RawBibliography<'_>) -> Self

Parse a bibliography from a raw bibliography.

pub fn get(&self, cite_key: &str) -> Option<&Entry>

Try to find an entry with the given cite key.

pub fn get_mut(&mut self, cite_key: &str) -> Option<&mut Entry>

Try to find an entry with the given cite key and return a mutable reference.

pub fn get_resolved(&mut self, cite_key: &str) -> Option<Entry>

Try to find an entry with the given cite key and return an Entry with all crossref and xdata dependencies resolved.

pub fn add(&mut self, entry: Entry) -> Result<()>

Add a new entry of that type to the bibliography if the cite key is not already in use.

pub fn add_empty(
    &mut self,
    cite_key: &str,
    entry_type: EntryType
) -> Result<&mut Entry>

Add a new entry of that type to the bibliography if the cite key is not already in use.

pub fn add_alias(&mut self, cite_key: &str, alias: &str) -> Result<()>

Will add an alias for a cite key if that alias is not yet in use

pub fn remove_item(&mut self, cite_key: &str) -> Result<Entry>

pub fn len(&self) -> usize

Get the amount of bibliography items.

pub fn iter<'a>(&'a self) -> Iter<'a, Entry>

An iterator over the bibliography's entries.

pub fn as_biblatex_string(&mut self) -> String

Will output the entry as a BibLaTeX string

Trait Implementations

impl Clone for Bibliography

fn clone(&self) -> Bibliography

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Bibliography

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

Formats the value using the given formatter.

impl IntoIterator for Bibliography

type Item = Entry

The type of the elements being iterated over.

type IntoIter = IntoIter<Entry>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.