Struct hayagriva::Entry

pub struct Entry { /* private fields */ }

A citable item in a bibliography.

Implementations

impl Entry

pub fn key(&self) -> &str

Get the key of the entry.

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

Construct a new, empty entry.

pub fn has(&self, key: &str) -> bool

Check whether the entry has some key.

impl Entry

Getters.

pub fn entry_type(&self) -> &EntryType

Get the type of the entry.

pub fn parents(&self) -> &[Entry]

Get the parents of the entry.

pub fn title(&self) -> Option<&FormatString>

Title of the item.

pub fn authors(&self) -> Option<&[Person]>

Persons primarily responsible for creating the item.

pub fn date(&self) -> Option<&Date>

Date at which the item was published.

pub fn editors(&self) -> Option<&[Person]>

Persons responsible for selecting and revising the content of the item.

pub fn affiliated(&self) -> Option<&[PersonsWithRoles]>

Persons involved in the production of the item that are not authors or editors.

pub fn publisher(&self) -> Option<&FormatString>

Publisher of the item.

pub fn location(&self) -> Option<&FormatString>

Physical location at which the item was published or created.

pub fn organization(&self) -> Option<&FormatString>

Organization at/for which the item was created.

pub fn issue(&self) -> Option<&MaybeTyped<Numeric>>

For an item whose parent has multiple issues, indicates the position in the issue sequence. Also used to indicate the episode number for TV.

pub fn volume(&self) -> Option<&MaybeTyped<Numeric>>

For an item whose parent has multiple volumes/parts/seasons … of which this item is one.

pub fn volume_total(&self) -> Option<&Numeric>

Total number of volumes/parts/seasons … this item consists of.

pub fn edition(&self) -> Option<&MaybeTyped<Numeric>>

Published version of an item.

pub fn page_range(&self) -> Option<&MaybeTyped<Numeric>>

The range of pages within the parent this item occupies

pub fn page_total(&self) -> Option<&Numeric>

The total number of pages the item has.

pub fn time_range(&self) -> Option<&MaybeTyped<DurationRange>>

The time range within the parent this item starts and ends at.

pub fn runtime(&self) -> Option<&MaybeTyped<Duration>>

The total runtime of the item.

pub fn url(&self) -> Option<&QualifiedUrl>

Canonical public URL of the item, can have access date.

pub fn serial_number(&self) -> Option<&SerialNumber>

Any serial number or version describing the item that is not appropriate for the fields doi, edition, isbn or issn (may be assigned by the author of the item; especially useful for preprint archives).

pub fn language(&self) -> Option<&LanguageIdentifier>

The language of the item.

pub fn archive(&self) -> Option<&FormatString>

Name of the institution/collection where the item is kept.

pub fn archive_location(&self) -> Option<&FormatString>

Physical location of the institution/collection where the item is kept.

pub fn call_number(&self) -> Option<&FormatString>

The call number of the item in the institution/collection.

pub fn note(&self) -> Option<&FormatString>

Additional description to be appended in the bibliographic entry.

pub fn abstract_(&self) -> Option<&FormatString>

Abstract of the item (e.g. the abstract of a journal article).

pub fn annote(&self) -> Option<&FormatString>

Short markup, decoration, or annotation to the item (e.g., to indicate items included in a review);

For descriptive text (e.g., in an annotated bibliography), use note instead.

pub fn genre(&self) -> Option<&FormatString>

Type, class, or subtype of the item (e.g. “Doctoral dissertation” for a PhD thesis; “NIH Publication” for an NIH technical report); Do not use for topical descriptions or categories (e.g. “adventure” for an adventure movie).

impl Entry

Setters.

pub fn set_parents(&mut self, parents: Vec<Entry>)

Set the parents of the entry.

pub fn set_title(&mut self, title: FormatString)

Set the title field.

pub fn set_authors(&mut self, authors: Vec<Person>)

Set the author field.

pub fn set_date(&mut self, date: Date)

Set the date field.

pub fn set_editors(&mut self, editors: Vec<Person>)

Set the editor field.

pub fn set_affiliated(&mut self, affiliated: Vec<PersonsWithRoles>)

Set the affiliated field.

pub fn set_publisher(&mut self, publisher: FormatString)

Set the publisher field.

pub fn set_location(&mut self, location: FormatString)

Set the location field.

pub fn set_organization(&mut self, organization: FormatString)

Set the organization field.

pub fn set_issue(&mut self, issue: MaybeTyped<Numeric>)

Set the issue field.

pub fn set_volume(&mut self, volume: MaybeTyped<Numeric>)

Set the volume field.

pub fn set_volume_total(&mut self, volume_total: Numeric)

Set the volume-total field.

pub fn set_edition(&mut self, edition: MaybeTyped<Numeric>)

Set the edition field.

pub fn set_page_range(&mut self, page_range: MaybeTyped<Numeric>)

Set the page-range field.

pub fn set_page_total(&mut self, page_total: Numeric)

Set the page-total field.

pub fn set_time_range(&mut self, time_range: MaybeTyped<DurationRange>)

Set the time-range field.

pub fn set_runtime(&mut self, runtime: MaybeTyped<Duration>)

Set the runtime field.

pub fn set_url(&mut self, url: QualifiedUrl)

Set the url field.

pub fn set_serial_number(&mut self, serial_number: SerialNumber)

Set the serial-number field.

pub fn set_language(&mut self, language: LanguageIdentifier)

Set the language field.

pub fn set_archive(&mut self, archive: FormatString)

Set the archive field.

pub fn set_archive_location(&mut self, archive_location: FormatString)

Set the archive-location field.

pub fn set_call_number(&mut self, call_number: FormatString)

Set the call-number field.

pub fn set_note(&mut self, note: FormatString)

Set the note field.

pub fn set_abstract_(&mut self, abstract_: FormatString)

Set the abstract field.

pub fn set_annote(&mut self, annote: FormatString)

Set the annote field.

pub fn set_genre(&mut self, genre: FormatString)

Set the genre field.

impl Entry

pub fn map<'a, F, T>(&'a self, f: F) -> Option<T>

where F: FnMut(&'a Self) -> Option<T>,

Get the unconverted value of a certain field from this entry or any of its parents.

pub fn map_parents<'a, F, T>(&'a self, f: F) -> Option<T>

where F: FnMut(&'a Self) -> Option<T>,

Get the unconverted value of a certain field from the parents only by BFS.

pub fn bound_select(&self, selector: &Selector, binding: &str) -> Option<&Entry>

Apply a selector and return a bound parent entry or self.

pub fn date_any(&self) -> Option<&Date>

Will recursively get a date off either the entry or any of its ancestors.

pub fn url_any(&self) -> Option<&QualifiedUrl>

Will recursively get an URL off either the entry or any of its ancestors.

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

Retrieve a keyed serial number.

pub fn set_keyed_serial_number(&mut self, key: &str, value: String)

Set a keyed serial number.

pub fn doi(&self) -> Option<&str>

The Digital Object Identifier of the item.

pub fn set_doi(&mut self, doi: String)

Set the doi field.

pub fn isbn(&self) -> Option<&str>

International Standard Book Number (ISBN), prefer ISBN-13.

pub fn set_isbn(&mut self, isbn: String)

Set the isbn field.

pub fn issn(&self) -> Option<&str>

International Standard Serial Number (ISSN).

pub fn set_issn(&mut self, issn: String)

Set the issn field.

pub fn pmid(&self) -> Option<&str>

PubMed Identifier (PMID).

pub fn set_pmid(&mut self, pmid: String)

Set the pmid field.

pub fn pmcid(&self) -> Option<&str>

PubMed Central Identifier (PMCID).

pub fn set_pmcid(&mut self, pmcid: String)

Set the pmcid field.

pub fn arxiv(&self) -> Option<&str>

ArXiv identifier.

pub fn set_arxiv(&mut self, arxiv: String)

Set the arxiv 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 FromIterator<Entry> for Library

fn from_iter<T: IntoIterator<Item = Entry>>(iter: T) -> Self

Creates a value from an iterator.

impl Hash for Entry

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq 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: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Entry

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&Entry> for Entry

type Error = TypeError

The type returned in the event of a conversion error.

fn try_from(entry: &Entry) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for Entry

impl StructuralPartialEq for Entry