Struct biblatex::Entry

pub struct Entry {
    pub cite_key: String,
    pub entry_type: EntryType,
    pub fields: HashMap<String, Vec<Chunk>>,
}

A bibliography entry that is parsed into chunks, which can be parsed into more specific types on demand on field accesses.

Fields

cite_key: String

The citation key.

entry_type: EntryType

Denotes the type of bibliography item (e.g. article).

fields: HashMap<String, Vec<Chunk>>

Maps from field names to their associated chunk vectors.

Implementations

impl Entry

pub fn new(cite_key: &str, entry_type: EntryType) -> Self

Construct new, empty entry.

pub fn get(&self, key: &str) -> Option<&[Chunk]>

Get the chunk slice for a field.

pub fn get_as<T: Type>(&self, key: &str) -> Result<T>

Get the chunk slice for a field and parse it as a specific type.

pub fn set(&mut self, key: &str, chunks: Vec<Chunk>)

Sets a field value as a chunk vector.

pub fn set_as<T: Type>(&mut self, key: &str, value: &T) -> Result<()>

Sets a field value as a chunk vector as a specific type.

pub fn delete(&mut self, key: &str) -> Option<Vec<Chunk>>

Deletes a field from the entry.

pub fn as_biblatex_string(&mut self) -> String

Will output the entry as a BibLaTeX string.

pub fn as_bibtex_string(&mut self) -> String

Will output the entry as a BibTeX string.

pub fn get_parents(&self) -> Vec<String>

Gets the parents of an entry in a semantic sense (crossref and xref).

impl Entry

pub fn get_author(&self) -> Result<Vec<Person>>

Get and parse the author field.

pub fn set_author(&mut self, item: Vec<Person>) -> Result<()>

Set a value in the author field.

pub fn get_book_title(&self) -> Result<&[Chunk]>

Get and parse the booktitle field.

pub fn set_book_title(&mut self, item: Vec<Chunk>) -> Result<()>

Set a value in the booktitle field.

pub fn get_chapter(&self) -> Result<&[Chunk]>

Get and parse the chapter field.

pub fn set_chapter(&mut self, item: Vec<Chunk>) -> Result<()>

Set a value in the chapter field.

pub fn get_edition(&self) -> Result<IntOrChunks>

Get and parse the edition field.

pub fn set_edition(&mut self, item: IntOrChunks) -> Result<()>

Set a value in the edition field.

pub fn get_how_published(&self) -> Result<&[Chunk]>

Get and parse the howpublished field.

pub fn set_how_published(&mut self, item: Vec<Chunk>) -> Result<()>

Set a value in the howpublished field.

pub fn get_note(&self) -> Result<&[Chunk]>

Get and parse the note field.

pub fn set_note(&mut self, item: Vec<Chunk>) -> Result<()>

Set a value in the note field.

pub fn get_number(&self) -> Result<&[Chunk]>

Get and parse the number field.

pub fn set_number(&mut self, item: Vec<Chunk>) -> Result<()>

Set a value in the number field.

pub fn get_organization(&self) -> Result<Vec<Vec<Chunk>>>

Get and parse the organization field.

pub fn set_organization(&mut self, item: Vec<Vec<Chunk>>) -> Result<()>

Set a value in the organization field.

pub fn get_pages(&self) -> Result<Vec<Range<u32>>>

Get and parse the pages field.

pub fn set_pages(&mut self, item: Vec<Range<u32>>) -> Result<()>

Set a value in the pages field.

pub fn get_publisher(&self) -> Result<Vec<Vec<Chunk>>>

Get and parse the publisher field.

pub fn set_publisher(&mut self, item: Vec<Vec<Chunk>>) -> Result<()>

Set a value in the publisher field.

pub fn get_series(&self) -> Result<&[Chunk]>

Get and parse the series field.

pub fn set_series(&mut self, item: Vec<Chunk>) -> Result<()>

Set a value in the series field.

pub fn get_title(&self) -> Result<&[Chunk]>

Get and parse the title field.

pub fn set_title(&mut self, item: Vec<Chunk>) -> Result<()>

Set a value in the title field.

pub fn get_type(&self) -> Result<String>

Get and parse the type field.

pub fn set_type(&mut self, item: String) -> Result<()>

Set a value in the type field.

pub fn get_volume(&self) -> Result<i64>

Get and parse the volume field.

pub fn set_volume(&mut self, item: i64) -> Result<()>

Set a value in the volume field.

pub fn get_date(&self) -> Result<Date>

Get and parse the date field, falling back to the year, month, and day fields when not present.

pub fn set_date(&mut self, item: Date) -> Result<()>

Set a value in the date field.

pub fn get_event_date(&self) -> Result<Date>

Get and parse the eventdate field, falling back to the eventyear, eventmonth, and eventday fields when not present.

pub fn set_event_date(&mut self, item: Date) -> Result<()>

Set a value in the eventdate field.

pub fn get_orig_date(&self) -> Result<Date>

Get and parse the origdate field, falling back to the origyear, origmonth, and origday fields when not present.

pub fn set_orig_date(&mut self, item: Date) -> Result<()>

Set a value in the origdate field.

pub fn get_url_date(&self) -> Result<Date>

Get and parse the urldate field, falling back to the urlyear, urlmonth, and urlday fields when not present.

pub fn set_url_date(&mut self, item: Date) -> Result<()>

Set a value in the urldate field.

pub fn get_editors(&self) -> Result<Vec<(Vec<Person>, EditorType)>>

Get and parse the editor and editora through editorc fields and their respective editortype annotation fields. If any of the above fields is present, this function will return a vector with between one and four entries, one for each editorial role.

The default EditorType::Editor will be assumed if the type field is empty.

pub fn get_address(&self) -> Result<&[Chunk]>

Get and parse the address field, falling back on location if address is empty.

pub fn set_address(&mut self, item: Vec<Chunk>) -> Result<()>

Set a value in the address field.

pub fn get_location(&self) -> Result<&[Chunk]>

Get and parse the location field, falling back on address if location is empty.

pub fn set_location(&mut self, item: Vec<Chunk>) -> Result<()>

Set a value in the location field.

pub fn get_annotation(&self) -> Result<&[Chunk]>

Get and parse the annotation field, falling back on annote if annotation is empty.

pub fn set_annotation(&mut self, item: Vec<Chunk>) -> Result<()>

Set a value in the annotation field.

pub fn get_eprint_type(&self) -> Result<&[Chunk]>

Get and parse the eprinttype field, falling back on archiveprefix if eprinttype is empty.

pub fn set_eprint_type(&mut self, item: Vec<Chunk>) -> Result<()>

Set a value in the eprinttype field.

pub fn get_journal(&self) -> Result<&[Chunk]>

Get and parse the journal field, falling back on journaltitle if journal is empty.

pub fn set_journal(&mut self, item: Vec<Chunk>) -> Result<()>

Set a value in the journal field.

pub fn get_journal_title(&self) -> Result<&[Chunk]>

Get and parse the journaltitle field, falling back on journal if journaltitle is empty.

pub fn set_journal_title(&mut self, item: Vec<Chunk>) -> Result<()>

Set a value in the journaltitle field.

pub fn get_sort_key(&self) -> Result<String>

Get and parse the key field, falling back on sortkey if key is empty.

pub fn set_sort_key(&mut self, item: String) -> Result<()>

Set a value in the key field.

pub fn get_file(&self) -> Result<String>

Get and parse the file field, falling back on pdf if file is empty.

pub fn set_file(&mut self, item: String) -> Result<()>

Set a value in the file field.

pub fn get_school(&self) -> Result<&[Chunk]>

Get and parse the school field, falling back on institution if school is empty.

pub fn set_school(&mut self, item: Vec<Chunk>) -> Result<()>

Set a value in the school field.

pub fn get_institution(&self) -> Result<&[Chunk]>

Get and parse the institution field, falling back on school if institution is empty.

pub fn set_institution(&mut self, item: Vec<Chunk>) -> Result<()>

Set a value in the institution field.

pub fn get_abstract(&self) -> Result<&[Chunk]>

Get and parse the abstract field.

pub fn set_abstract(&mut self, item: Vec<Chunk>) -> Result<()>

Set a value in the abstract field.

pub fn get_addendum(&self) -> Result<&[Chunk]>

Get and parse the addendum field.

pub fn set_addendum(&mut self, item: Vec<Chunk>) -> Result<()>

Set a value in the addendum field.

pub fn get_afterword(&self) -> Result<Vec<Person>>

Get and parse the afterword field.

pub fn set_afterword(&mut self, item: Vec<Person>) -> Result<()>

Set a value in the afterword field.

pub fn get_annotator(&self) -> Result<Vec<Person>>

Get and parse the annotator field.

pub fn set_annotator(&mut self, item: Vec<Person>) -> Result<()>

Set a value in the annotator field.

pub fn get_author_type(&self) -> Result<String>

Get and parse the authortype field.

pub fn set_author_type(&mut self, item: String) -> Result<()>

Set a value in the authortype field.

pub fn get_book_author(&self) -> Result<Vec<Person>>

Get and parse the bookauthor field.

pub fn set_book_author(&mut self, item: Vec<Person>) -> Result<()>

Set a value in the bookauthor field.

pub fn get_book_pagination(&self) -> Result<Pagination>

Get and parse the bookpagination field.

pub fn set_book_pagination(&mut self, item: Pagination) -> Result<()>

Set a value in the bookpagination field.

pub fn get_book_subtitle(&self) -> Result<&[Chunk]>

Get and parse the booksubtitle field.

pub fn set_book_subtitle(&mut self, item: Vec<Chunk>) -> Result<()>

Set a value in the booksubtitle field.

pub fn get_book_title_addon(&self) -> Result<&[Chunk]>

Get and parse the booktitleaddon field.

pub fn set_book_title_addon(&mut self, item: Vec<Chunk>) -> Result<()>

Set a value in the booktitleaddon field.

pub fn get_commentator(&self) -> Result<Vec<Person>>

Get and parse the commentator field.

pub fn set_commentator(&mut self, item: Vec<Person>) -> Result<()>

Set a value in the commentator field.

pub fn get_doi(&self) -> Result<String>

Get and parse the doi field.

pub fn set_doi(&mut self, item: String) -> Result<()>

Set a value in the doi field.

pub fn get_eid(&self) -> Result<&[Chunk]>

Get and parse the eid field.

pub fn set_eid(&mut self, item: Vec<Chunk>) -> Result<()>

Set a value in the eid field.

pub fn get_entry_subtype(&self) -> Result<&[Chunk]>

Get and parse the entrysubtype field.

pub fn set_entry_subtype(&mut self, item: Vec<Chunk>) -> Result<()>

Set a value in the entrysubtype field.

pub fn get_eprint(&self) -> Result<String>

Get and parse the eprint field.

pub fn set_eprint(&mut self, item: String) -> Result<()>

Set a value in the eprint field.

pub fn get_eprint_class(&self) -> Result<&[Chunk]>

Get and parse the eprintclass field.

pub fn set_eprint_class(&mut self, item: Vec<Chunk>) -> Result<()>

Set a value in the eprintclass field.

pub fn get_eventtitle(&self) -> Result<&[Chunk]>

Get and parse the eventtitle field.

pub fn set_eventtitle(&mut self, item: Vec<Chunk>) -> Result<()>

Set a value in the eventtitle field.

pub fn get_eventtitle_addon(&self) -> Result<&[Chunk]>

Get and parse the eventtitleaddon field.

pub fn set_eventtitle_addon(&mut self, item: Vec<Chunk>) -> Result<()>

Set a value in the eventtitleaddon field.

pub fn get_foreword(&self) -> Result<Vec<Person>>

Get and parse the foreword field.

pub fn set_foreword(&mut self, item: Vec<Person>) -> Result<()>

Set a value in the foreword field.

pub fn get_holder(&self) -> Result<Vec<Person>>

Get and parse the holder field.

pub fn set_holder(&mut self, item: Vec<Person>) -> Result<()>

Set a value in the holder field.

pub fn get_index_title(&self) -> Result<&[Chunk]>

Get and parse the indextitle field.

pub fn set_index_title(&mut self, item: Vec<Chunk>) -> Result<()>

Set a value in the indextitle field.

pub fn get_introduction(&self) -> Result<Vec<Person>>

Get and parse the introduction field.

pub fn set_introduction(&mut self, item: Vec<Person>) -> Result<()>

Set a value in the introduction field.

pub fn get_isan(&self) -> Result<&[Chunk]>

Get and parse the isan field.

pub fn set_isan(&mut self, item: Vec<Chunk>) -> Result<()>

Set a value in the isan field.

pub fn get_isbn(&self) -> Result<&[Chunk]>

Get and parse the isbn field.

pub fn set_isbn(&mut self, item: Vec<Chunk>) -> Result<()>

Set a value in the isbn field.

pub fn get_ismn(&self) -> Result<&[Chunk]>

Get and parse the ismn field.

pub fn set_ismn(&mut self, item: Vec<Chunk>) -> Result<()>

Set a value in the ismn field.

pub fn get_isrn(&self) -> Result<&[Chunk]>

Get and parse the isrn field.

pub fn set_isrn(&mut self, item: Vec<Chunk>) -> Result<()>

Set a value in the isrn field.

pub fn get_issn(&self) -> Result<&[Chunk]>

Get and parse the issn field.

pub fn set_issn(&mut self, item: Vec<Chunk>) -> Result<()>

Set a value in the issn field.

pub fn get_issue(&self) -> Result<&[Chunk]>

Get and parse the issue field.

pub fn set_issue(&mut self, item: Vec<Chunk>) -> Result<()>

Set a value in the issue field.

pub fn get_issue_subtitle(&self) -> Result<&[Chunk]>

Get and parse the issuesubtitle field.

pub fn set_issue_subtitle(&mut self, item: Vec<Chunk>) -> Result<()>

Set a value in the issuesubtitle field.

pub fn get_issue_title(&self) -> Result<&[Chunk]>

Get and parse the issuetitle field.

pub fn set_issue_title(&mut self, item: Vec<Chunk>) -> Result<()>

Set a value in the issuetitle field.

pub fn get_issue_title_addon(&self) -> Result<&[Chunk]>

Get and parse the issuetitleaddon field.

pub fn set_issue_title_addon(&mut self, item: Vec<Chunk>) -> Result<()>

Set a value in the issuetitleaddon field.

pub fn get_iswc(&self) -> Result<&[Chunk]>

Get and parse the iswc field.

pub fn set_iswc(&mut self, item: Vec<Chunk>) -> Result<()>

Set a value in the iswc field.

pub fn get_journal_subtitle(&self) -> Result<&[Chunk]>

Get and parse the journalsubtitle field.

pub fn set_journal_subtitle(&mut self, item: Vec<Chunk>) -> Result<()>

Set a value in the journalsubtitle field.

pub fn get_journal_title_addon(&self) -> Result<&[Chunk]>

Get and parse the journaltitleaddon field.

pub fn set_journal_title_addon(&mut self, item: Vec<Chunk>) -> Result<()>

Set a value in the journaltitleaddon field.

pub fn get_keywords(&self) -> Result<&[Chunk]>

Get and parse the keywords field.

pub fn set_keywords(&mut self, item: Vec<Chunk>) -> Result<()>

Set a value in the keywords field.

pub fn get_label(&self) -> Result<&[Chunk]>

Get and parse the label field.

pub fn set_label(&mut self, item: Vec<Chunk>) -> Result<()>

Set a value in the label field.

pub fn get_language(&self) -> Result<String>

Get and parse the language field.

pub fn set_language(&mut self, item: String) -> Result<()>

Set a value in the language field.

pub fn get_library(&self) -> Result<&[Chunk]>

Get and parse the library field.

pub fn set_library(&mut self, item: Vec<Chunk>) -> Result<()>

Set a value in the library field.

pub fn get_main_subtitle(&self) -> Result<&[Chunk]>

Get and parse the mainsubtitle field.

pub fn set_main_subtitle(&mut self, item: Vec<Chunk>) -> Result<()>

Set a value in the mainsubtitle field.

pub fn get_main_title(&self) -> Result<&[Chunk]>

Get and parse the maintitle field.

pub fn set_main_title(&mut self, item: Vec<Chunk>) -> Result<()>

Set a value in the maintitle field.

pub fn get_main_title_addon(&self) -> Result<&[Chunk]>

Get and parse the maintitleaddon field.

pub fn set_main_title_addon(&mut self, item: Vec<Chunk>) -> Result<()>

Set a value in the maintitleaddon field.

pub fn get_name_addon(&self) -> Result<&[Chunk]>

Get and parse the nameaddon field.

pub fn set_name_addon(&mut self, item: Vec<Chunk>) -> Result<()>

Set a value in the nameaddon field.

pub fn get_options(&self) -> Result<&[Chunk]>

Get and parse the options field.

pub fn set_options(&mut self, item: Vec<Chunk>) -> Result<()>

Set a value in the options field.

pub fn get_orig_language(&self) -> Result<String>

Get and parse the origlanguage field.

pub fn set_orig_language(&mut self, item: String) -> Result<()>

Set a value in the origlanguage field.

pub fn get_orig_location(&self) -> Result<&[Chunk]>

Get and parse the origlocation field.

pub fn set_orig_location(&mut self, item: Vec<Chunk>) -> Result<()>

Set a value in the origlocation field.

pub fn get_page_total(&self) -> Result<&[Chunk]>

Get and parse the pagetotal field.

pub fn set_page_total(&mut self, item: Vec<Chunk>) -> Result<()>

Set a value in the pagetotal field.

pub fn get_pagination(&self) -> Result<Pagination>

Get and parse the pagination field.

pub fn set_pagination(&mut self, item: Pagination) -> Result<()>

Set a value in the pagination field.

pub fn get_part(&self) -> Result<&[Chunk]>

Get and parse the part field.

pub fn set_part(&mut self, item: Vec<Chunk>) -> Result<()>

Set a value in the part field.

pub fn get_pubstate(&self) -> Result<&[Chunk]>

Get and parse the pubstate field.

pub fn set_pubstate(&mut self, item: Vec<Chunk>) -> Result<()>

Set a value in the pubstate field.

pub fn get_reprint_title(&self) -> Result<&[Chunk]>

Get and parse the reprinttitle field.

pub fn set_reprint_title(&mut self, item: Vec<Chunk>) -> Result<()>

Set a value in the reprinttitle field.

pub fn get_short_author(&self) -> Result<Vec<Person>>

Get and parse the shortauthor field.

pub fn set_short_author(&mut self, item: Vec<Person>) -> Result<()>

Set a value in the shortauthor field.

pub fn get_short_editor(&self) -> Result<Vec<Person>>

Get and parse the shorteditor field.

pub fn set_short_editor(&mut self, item: Vec<Person>) -> Result<()>

Set a value in the shorteditor field.

pub fn get_shorthand(&self) -> Result<&[Chunk]>

Get and parse the shorthand field.

pub fn set_shorthand(&mut self, item: Vec<Chunk>) -> Result<()>

Set a value in the shorthand field.

pub fn get_shorthand_intro(&self) -> Result<&[Chunk]>

Get and parse the shorthandintro field.

pub fn set_shorthand_intro(&mut self, item: Vec<Chunk>) -> Result<()>

Set a value in the shorthandintro field.

pub fn get_short_journal(&self) -> Result<&[Chunk]>

Get and parse the shortjournal field.

pub fn set_short_journal(&mut self, item: Vec<Chunk>) -> Result<()>

Set a value in the shortjournal field.

pub fn get_short_series(&self) -> Result<&[Chunk]>

Get and parse the shortseries field.

pub fn set_short_series(&mut self, item: Vec<Chunk>) -> Result<()>

Set a value in the shortseries field.

pub fn get_short_title(&self) -> Result<&[Chunk]>

Get and parse the shorttitle field.

pub fn set_short_title(&mut self, item: Vec<Chunk>) -> Result<()>

Set a value in the shorttitle field.

pub fn get_subtitle(&self) -> Result<&[Chunk]>

Get and parse the subtitle field.

pub fn set_subtitle(&mut self, item: Vec<Chunk>) -> Result<()>

Set a value in the subtitle field.

pub fn get_title_addon(&self) -> Result<&[Chunk]>

Get and parse the titleaddon field.

pub fn set_title_addon(&mut self, item: Vec<Chunk>) -> Result<()>

Set a value in the titleaddon field.

pub fn get_translator(&self) -> Result<Vec<Person>>

Get and parse the translator field.

pub fn set_translator(&mut self, item: Vec<Person>) -> Result<()>

Set a value in the translator field.

pub fn get_url(&self) -> Result<String>

Get and parse the url field.

pub fn set_url(&mut self, item: String) -> Result<()>

Set a value in the url field.

pub fn get_venue(&self) -> Result<&[Chunk]>

Get and parse the venue field.

pub fn set_venue(&mut self, item: Vec<Chunk>) -> Result<()>

Set a value in the venue field.

pub fn get_version(&self) -> Result<&[Chunk]>

Get and parse the version field.

pub fn set_version(&mut self, item: Vec<Chunk>) -> Result<()>

Set a value in the version field.

pub fn get_volumes(&self) -> Result<i64>

Get and parse the volumes field.

pub fn set_volumes(&mut self, item: i64) -> Result<()>

Set a value in the volumes field.

pub fn get_gender(&self) -> Result<Gender>

Get and parse the gender field.

pub fn set_gender(&mut self, item: Gender) -> Result<()>

Set a value in the gender field.

Trait Implementations

impl Clone for Entry

fn clone(&self) -> Entry

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Entry

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

Formats the value using the given formatter.

impl Eq for Entry

impl PartialEq<Entry> for Entry

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

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

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

This method tests for !=.

impl StructuralEq for Entry

impl StructuralPartialEq for Entry