Struct Reference

pub struct Reference {Show 18 fields
    pub id: String,
    pub publication_type: Option<String>,
    pub title: Option<String>,
    pub authors: Vec<Author>,
    pub source: Option<String>,
    pub year: Option<String>,
    pub volume: Option<String>,
    pub issue: Option<String>,
    pub pages: Option<String>,
    pub elocation_id: Option<String>,
    pub editors: Vec<Author>,
    pub publisher_name: Option<String>,
    pub publisher_loc: Option<String>,
    pub edition: Option<String>,
    pub isbn: Option<String>,
    pub conf_name: Option<String>,
    pub pmid: Option<String>,
    pub doi: Option<String>,
}

Expand description

Reference citation.

Maps to JATS <ref> containing <element-citation> or <mixed-citation>.

Fields§

§id: String

Reference ID. From <ref id="...">.

§publication_type: Option<String>

Publication type. From <element-citation publication-type="...">. Common values: "journal", "book", "web", "other".

§title: Option<String>

Article or chapter title. From <article-title> or <chapter-title>.

§authors: Vec<Author>

Authors. From <person-group>/<name>.

§source: Option<String>

Source (journal name or book title). From <source>.

§year: Option<String>

Publication year. From <year>.

§volume: Option<String>

Volume. From <volume>.

§issue: Option<String>

Issue. From <issue>.

§pages: Option<String>

Page range. From <fpage>-<lpage>.

§elocation_id: Option<String>

Electronic location ID. From <elocation-id> (used by e-journals in place of page numbers).

§editors: Vec<Author>

Editors. From <person-group person-group-type="editor"> (common for book and book-chapter citations).

§publisher_name: Option<String>

Publisher name. From <publisher-name> (book / report citations).

§publisher_loc: Option<String>

Publisher location. From <publisher-loc>.

§edition: Option<String>

Edition. From <edition>.

§isbn: Option<String>

ISBN. From <isbn> (book citations).

§conf_name: Option<String>

Conference name. From <conf-name> (conference-proceedings citations).

§pmid: Option<String>

PubMed ID. From <pub-id pub-id-type="pmid">.

§doi: Option<String>

DOI. From <pub-id pub-id-type="doi">.

Implementations§

§

impl Reference

pub fn format_citation(&self) -> String

Format a human-readable citation string.

§

impl Reference

pub fn has_pmid(&self) -> bool

Whether this reference carries a PubMed ID.

pub fn has_doi(&self) -> bool

Whether this reference carries a DOI.

Trait Implementations§

§

impl Clone for Reference

§

fn clone(&self) -> Reference

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

§

impl Debug for Reference

§

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

Formats the value using the given formatter. Read more

§

impl<'de> Deserialize<'de> for Reference

§

fn deserialize<D>( deserializer: D, ) -> Result<Reference, <D as Deserializer<'de>>::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

§

impl PartialEq for Reference

§

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

Tests for self and other values to be equal, and is used by ==.

1.0.0 · Source§

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

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

§

impl Serialize for Reference

§

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>
where S: Serializer,

Serialize this value into the given Serde serializer. Read more

§

impl StructuralPartialEq for Reference

Auto Trait Implementations§

§

impl UnwindSafe for Reference

Blanket Implementations§

Source §

impl<T> Any for T
where T: 'static + ?Sized,

Source §

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

Source §

impl<T> Borrow<T> for T
where T: ?Sized,

Source §

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

Source §

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source §

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

Source §

impl<T> CloneToUninit for T
where T: Clone,

Source §

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more

§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Source §

impl<T, U> Into for T
where U: From<T>,

Source §

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source §

impl<T> IntoEither for T

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

§