Skip to main content

Bibliography

Struct Bibliography 

Source
pub struct Bibliography { /* private fields */ }
Expand description

Every citation key defined by a directory of .bib files, and the entry each key resolves to.

Implementations§

Source§

impl Bibliography

Source

pub fn load_dir(dir: impl AsRef<Path>) -> Result<Self>

Loads every *.bib file directly inside dir (non-recursive) and merges their entries into one bibliography.

Files are processed in sorted filename order. Directory read order is OS-dependent, so sorting first is what makes both iteration order and duplicate-key attribution reproducible across machines rather than incidental.

A directory holding no .bib files loads to an empty bibliography rather than an error: a docs project can legitimately wire up its bibliography directory before writing the first citation.

§Errors
Source

pub fn from_entries(entries: impl IntoIterator<Item = (String, Entry)>) -> Self

Builds a bibliography directly from parsed entries, for callers that hold .bib content in memory rather than on disk.

Source

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

Returns the entry a citation key resolves to, or None if no loaded file defines it.

Source

pub fn len(&self) -> usize

Returns the number of distinct citation keys loaded.

Source

pub fn is_empty(&self) -> bool

Returns true when no citation keys were loaded.

Trait Implementations§

Source§

impl Clone for Bibliography

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Bibliography

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Bibliography

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.