Enum csl::variables::Variable

pub enum Variable {
    Abstract,
    Annote,
    Archive,
    ArchiveLocation,
    ArchivePlace,
    Authority,
    CallNumber,
    CitationLabel,
    CollectionTitle,
    ContainerTitle,
    ContainerTitleShort,
    Dimensions,
    DOI,
    Event,
    EventPlace,
    Genre,
    ISBN,
    ISSN,
    Jurisdiction,
    Keyword,
    Medium,
    Note,
    OriginalPublisher,
    OriginalPublisherPlace,
    OriginalTitle,
    PMCID,
    PMID,
    Publisher,
    PublisherPlace,
    References,
    ReviewedTitle,
    Scale,
    Section,
    Source,
    Status,
    Title,
    TitleShort,
    URL,
    Version,
    YearSuffix,
    Hereinafter,
    Dummy,
    LocatorExtra,
    VolumeTitle,
    Committee,
    DocumentName,
    GazetteFlag,
    Language,
}

Variants

Abstract

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

Annote

reader’s notes about the item content

Archive

archive storing the item

ArchiveLocation

storage location within an archive (e.g. a box and folder number) technically the spec says use an underscore, but that's probably a typo.

ArchivePlace

geographic location of the archive,

Authority

issuing or judicial authority (e.g. “USPTO” for a patent, “Fairfax Circuit Court” for a legal case) CSL-M only

CallNumber

active={true} call number (to locate the item in a library)

CitationLabel

label identifying the item in in-text citations of label styles (e.g. “Ferr78”). May be assigned by the CSL processor based on item metadata.

CollectionTitle

title of the collection holding the item (e.g. the series title for a book)

ContainerTitle

title of the container holding the item (e.g. the book title for a book chapter, the journal title for a journal article)

ContainerTitleShort

short/abbreviated form of “container-title” (also accessible through the “short” form of the “container-title” variable)

Dimensions

physical (e.g. size) or temporal (e.g. running time) dimensions of the item

DOI

Digital Object Identifier (e.g. “10.1128/AEM.02591-07”)

Event

name of the related event (e.g. the conference name when citing a conference paper)

EventPlace

geographic location of the related event (e.g. “Amsterdam, the Netherlands”)

Genre

class, type or genre of the item (e.g. “adventure” for an adventure movie, “PhD dissertation” for a PhD thesis)

ISBN

International Standard Book Number

ISSN

International Standard Serial Number

Jurisdiction

geographic scope of relevance (e.g. “US” for a US patent)

Keyword

keyword(s) or tag(s) attached to the item

Medium

medium description (e.g. “CD”, “DVD”, etc.)

Note

(short) inline note giving additional item details (e.g. a concise summary or commentary)

OriginalPublisher

original publisher, for items that have been republished by a different publisher

OriginalPublisherPlace

geographic location of the original publisher (e.g. “London, UK”)

OriginalTitle

title of the original version (e.g. “Война и мир”, the untranslated Russian title of “War and Peace”)

PMCID

PubMed Central reference number

PMID

PubMed reference number

Publisher

publisher

PublisherPlace

geographic location of the publisher

References

resources related to the procedural history of a legal case

ReviewedTitle

title of the item reviewed by the current item

Scale

scale of e.g. a map

Section

container section holding the item (e.g. “politics” for a newspaper article). TODO: CSL-M appears to interpret this as a number variable?

Source

from whence the item originates (e.g. a library catalog or database)

Status

(publication) status of the item (e.g. “forthcoming”)

Title

primary title of the item

TitleShort

short/abbreviated form of “title” (also accessible through the “short” form of the “title” variable)

URL

URL (e.g. “https://aem.asm.org/cgi/content/full/74/9/2766”)

Version

version of the item (e.g. “2.0.9” for a software program)

YearSuffix

disambiguating year suffix in author-date styles (e.g. “a” in “Doe, 1999a”)

Hereinafter

CSL-M only

Dummy

CSL-M only

LocatorExtra

CSL-M only

VolumeTitle

CSL-M only

Committee

CSL-M only

Not documented in the CSL-M spec.

DocumentName

CSL-M only

Not documented in the CSL-M spec. See Indigo Book section 'R26. Short Form Citation for Court Documents' for its intended use case, and the Juris-M US cheat sheet

GazetteFlag

CSL-M only

Not documented in the CSL-M spec.

TODO: I think variable="gazette-flag" may have been superseded by type="gazette", but clearly you can still tick the "Gazette Ref" checkbox in Juris-M on a statute. Ask Frank. See also https://juris-m.github.io/cheat-sheets/us.pdf

Language

Methods

impl Variable

pub fn should_replace_hyphens(self) -> bool

pub fn hyperlink(self, value: &str) -> Option<&str>

Trait Implementations

impl PartialEq<Variable> for Variable

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

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl AsRef<str> for Variable

fn as_ref(&self) -> &str

Performs the conversion.

impl Clone for Variable

fn clone(&self) -> Variable

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Eq for Variable

impl Copy for Variable

impl Debug for Variable

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

Formats the value using the given formatter.

impl Hash for Variable

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, 

Feeds a slice of this type into the given [Hasher].

impl FromStr for Variable

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Variable, Self::Err>

Parses a string s to return a value of this type.

impl EnumProperty for Variable

fn get_str(&self, prop: &str) -> Option<&'static str>

fn get_int(&self, &str) -> Option<usize>

fn get_bool(&self, &str) -> Option<bool>