17 releases

0.9.3 Mar 7, 2024
0.9.1 Nov 29, 2023
0.8.0 Apr 4, 2023
0.7.0 Mar 27, 2023
0.3.0 Sep 13, 2020

#155 in Parser implementations

Download history 951/week @ 2024-01-28 927/week @ 2024-02-04 1340/week @ 2024-02-11 914/week @ 2024-02-18 1156/week @ 2024-02-25 1843/week @ 2024-03-03 2382/week @ 2024-03-10 1748/week @ 2024-03-17 1143/week @ 2024-03-24 1234/week @ 2024-03-31 1049/week @ 2024-04-07 914/week @ 2024-04-14 860/week @ 2024-04-21 1059/week @ 2024-04-28 810/week @ 2024-05-05 1153/week @ 2024-05-12

3,971 downloads per month
Used in 27 crates (6 directly)

MIT/Apache

205KB
5K SLoC

BibLaTeX

Build status Current crates.io release Documentation

A Rust crate for parsing and writing BibTeX and BibLaTeX files.

BibLaTeX can help you to parse .bib bibliography files. As opposed to other available crates, this crate attempts to parse the data within the fields into easily usable structs and enums like Person and Date for downstream consumption.

Usage

Add this to your Cargo.toml:

[dependencies]
biblatex = "0.9"

Parsing a bibliography and getting the author of an item is as simple as:

let src = "@book{tolkien1937, author = {J. R. R. Tolkien}}";
let bibliography = Bibliography::parse(src).unwrap();
let entry = bibliography.get("tolkien1937").unwrap();
let author = entry.author().unwrap();
assert_eq!(author[0].name, "Tolkien");

This library operates on a Bibliography struct, which is a collection of entries (the items in your .bib file that start with an @ and are wrapped in curly braces). The entries may hold multiple fields. Entries have getter methods for each of the possible fields in a Bib(La)TeX file which handle possible field aliases, composition and type conversion automatically.

Refer to the WikiBook section on LaTeX bibliography management and the BibLaTeX package manual to learn more about the intended meaning of each of the fields.

The generated documentation more specifically describes the selection and behavior of the getters but generally, they follow the convention of being the snake-case name of the corresponding field (such that the getter for booktitleaddon is named book_title_addon).

Limitations

This library attempts to provide fairly comprehensive coverage of the BibLaTeX spec with which most of the .bib files in circulation can be processed.

However, the crate currently has some limitations:

  • There is no explicit support for entry sets, although it is easy to account for them by manually getting the entryset field and calling parse::<Vec<String>>() on it

Dependencies

~1–1.7MB
~61K SLoC