https://github.com/charlesvdv/nom-bibtex

A feature complete bibtex parser using nom
https://github.com/charlesvdv/nom-bibtex

bibtex latex nom parser rust zero-copy

Last synced: 2 months ago
JSON representation

A feature complete bibtex parser using nom

• Host: GitHub
• URL: https://github.com/charlesvdv/nom-bibtex
• Owner: charlesvdv
• License: mit
• Created: 2017-05-21T19:34:51.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2025-12-22T17:39:03.000Z (6 months ago)
• Last Synced: 2026-01-02T08:22:16.521Z (6 months ago)
• Topics: bibtex, latex, nom, parser, rust, zero-copy
• Language: Rust
• Homepage: https://docs.rs/nom-bibtex
• Size: 5.06 MB
• Stars: 26
• Watchers: 3
• Forks: 15
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# nom-bibtex

[![Rust](https://github.com/charlesvdv/nom-bibtex/workflows/Rust/badge.svg)](https://github.com/charlesvdv/nom-bibtex/actions)

[![Docs Badge](https://docs.rs/nom-bibtex/badge.svg)](https://docs.rs/nom-bibtex)

[![crates.io](https://img.shields.io/crates/v/nom-bibtex.svg)](https://crates.io/crates/nom-bibtex)

A feature complete *BibTeX* parser using [nom](https://github.com/rust-bakery/nom).

**nom-bibtex** can parse the four differents types of entries listed in the

[BibTeX format description](http://www.bibtex.org/Format/):

- Preambles which allows to call *LaTeX* command inside your *BibTeX*.

- Strings which defines abbreviations in a key-value format.

- Comments.

- Bibliography entries.

## Example

```rust

extern crate nom_bibtex;

use nom_bibtex::*;

const BIBFILE_DATA: &str = r#"@preamble{

        "A bibtex preamble"

    }

    @Comment{

        Here is a comment.

    }

    Another comment!

    @string ( name= "Charles Vandevoorde")

    @string (github = "https://github.com/charlesvdv")

    @misc {my_citation_key,

        author= name,

        title = "nom-bibtex",

        note = "Github: " # github

    }

"#;

fn main() {

    let bibtex = Bibtex::parse(BIBFILE_DATA).unwrap();

    let preambles = bibtex.preambles();

    assert_eq!(preambles[0], "A bibtex preamble");

    let comments = bibtex.comments();

    assert_eq!(comments[0], "Here is a comment.");

    assert_eq!(comments[1], "Another comment!");

    let variables = bibtex.variables();

    assert_eq!(variables["name"], "Charles Vandevoorde");

    assert_eq!(variables["github"], "https://github.com/charlesvdv");

    let biblio = &bibtex.bibliographies()[0];

    assert_eq!(biblio.entry_type(), "misc");

    assert_eq!(biblio.citation_key(), "my_citation_key");

    let bib_tags = biblio.tags();

    assert_eq!(bib_tags["author"], "Charles Vandevoorde");

    assert_eq!(bib_tags["title"], "nom-bibtex");

    assert_eq!(bib_tags["note"], "Github: https://github.com/charlesvdv");

}

```