Struct biblatex::Bibliography

pub struct Bibliography { /* private fields */ }

A fully parsed bibliography.

Implementations

impl Bibliography

pub fn new() -> Self

Create a new, empty bibliography.

pub fn parse(src: &str) -> Result<Self, ParseError>

Parse a bibliography from a source string.

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

Construct a bibliography from a raw bibliography, with the xdata and crossref links resolved.

pub fn len(&self) -> usize

The number of bibliography entries.

pub fn is_empty(&self) -> bool

Whether the bibliography is empty.

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

Returns the entry with the given cite key.

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

Returns a mutable reference to the entry with the given cite key.

pub fn insert(&mut self, entry: Entry) -> Option<Entry>

Insert an entry into the bibliography.

If an entry with the same cite key is already present, the entry is updated and the old entry is returned.

pub fn remove(&mut self, key: &str) -> Option<Entry>

Remove the entry with the given cite key.

pub fn alias(&mut self, key: &str, alias: impl Into<String>)

Add an alias for a cite key.

Does nothing if no entry with the given cite key exists.

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

An iterator over the bibliography’s entries.

pub fn iter_mut(&mut self) -> IterMut<'_, Entry>

A mutable iterator over the bibliography’s entries.

pub fn into_vec(self) -> Vec<Entry>

Consume this struct and return a vector of the bibliography’s entries.

pub fn write_biblatex(&self, sink: impl Write) -> Result

Write the entry into a writer in the BibLaTeX format.

pub fn to_biblatex_string(&self) -> String

Serialize this bibliography into a BibLaTeX string.

pub fn write_bibtex(&self, sink: impl Write) -> Result

Write the entry into a writer in the BibTeX format.

pub fn to_bibtex_string(&self) -> String

Serialize this bibliography into a BibTeX 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 Default for Bibliography

fn default() -> Bibliography

Returns the “default value” for a type.

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.

impl PartialEq for Bibliography

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Bibliography

impl StructuralEq for Bibliography

impl StructuralPartialEq for Bibliography