Struct inspirer::Inspirer

pub struct Inspirer { /* fields omitted */ }

Methods

impl Inspirer

fn init(logger: Option<Logger>) -> Self

Initialize 'Inspirer'

Either provide a custom slog::Logger or default to the standard log crate.

Examples

inspirer::Inspirer::init(None);

fn get_input(&self, input_source: Option<&str>) -> Result<String>

Read input from file or stdin

Examples

fn put_output(
    &self,
    output_dest: Option<&str>,
    output: Vec<String>
) -> Result<()>

Write output to file or stdout

fn aux2key(&self, input_data: String) -> Vec<String>

The aux2key function extracts TeX keys from LaTeX .aux files. These can be for either BibTeX or BibLaTeX.

Examples

bibtex

Inspire-formatted BibTeX key:

let inspirer = inspirer::Inspirer::init(None);

let input =
r"\relax
\citation{Abramovici:1992ah}".to_string();

assert_eq!(inspirer.aux2key(input), vec!("Abramovici:1992ah"));

ADS-formatted BibTeX Key:

let inspirer = inspirer::Inspirer::init(None);

let input =
r"\relax
\citation{1998PhRvD..58h4020O}".to_string();

assert_eq!(inspirer.aux2key(input), vec!("1998PhRvD..58h4020O"));

biber

Inspire-formatted BibLaTeX key:

let inspirer = inspirer::Inspirer::init(None);

let input =
r"\relax
\abx@aux@cite{Cutler:1992tc}".to_string();

assert_eq!(inspirer.aux2key(input), vec!("Cutler:1992tc"));

fn blg2key(&self, input_data: String) -> Vec<String>

The blg2key function extracts missing references from bibtex logs

Examples

ADS-formatted BibTeX key:

let inspirer = inspirer::Inspirer::init(None);

let input =
r##"
This is BibTeX, Version 0.99d (TeX Live 2016/Arch Linux)
Capacity: max_strings=35307, hash_size=35307, hash_prime=30011
The top-level auxiliary file: test_bibtex.aux
The style file: unsrt.bst
Database file #1: test_bibtex.bib
Warning--I didn't find a database entry for "2015CQGra..32g4001L"
You've used 0 entries,
....
"##.to_string();

assert_eq!(inspirer.blg2key(input), vec!("2015CQGra..32g4001L"));

fn bibtex(&self, key: &str) -> Option<String>

Fetch BibTeX entries