Enum csl::variables::NumberVariable

pub enum NumberVariable {
    ChapterNumber,
    CollectionNumber,
    Edition,
    Issue,
    Number,
    NumberOfPages,
    NumberOfVolumes,
    Volume,
    Locator,
    Page,
    PageFirst,
    FirstReferenceNoteNumber,
    CitationNumber,
    PublicationNumber,
    Supplement,
    Authority,
}

Variants

ChapterNumberCollectionNumberEditionIssueNumberNumberOfPagesNumberOfVolumesVolumeLocator

Locator, Page and PageFirst, FRRN, and CiteNumber: These are technically meant to be standard variables in CSL 1.0.1, but the spec requires us to treat them as numerics for <label plural="contextual"> anyway.

a cite-specific pinpointer within the item (e.g. a page number within a book, or a volume in a multi-volume work). Must be accompanied in the input data by a label indicating the locator type (see the Locators term list), which determines which term is rendered by cs:label when the “locator” variable is selected.

Page

range of pages the item (e.g. a journal article) covers in a container (e.g. a journal issue)

PageFirst

first page of the range of pages the item (e.g. a journal article) covers in a container (e.g. a journal issue)

FirstReferenceNoteNumber

number of a preceding note containing the first reference to the item. Assigned by the CSL processor. The variable holds no value for non-note-based styles, or when the item hasn’t been cited in any preceding notes.

CitationNumber

index (starting at 1) of the cited reference in the bibliography (generated by the CSL processor)

PublicationNumber

CSL-M only

Supplement

CSL-M only

Authority

CSL-M only

Methods

impl NumberVariable

pub fn should_replace_hyphens(self) -> bool

Trait Implementations

impl PartialEq<NumberVariable> for NumberVariable

fn eq(&self, other: &NumberVariable) -> 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 NumberVariable

fn as_ref(&self) -> &str

Performs the conversion.

impl Clone for NumberVariable

fn clone(&self) -> NumberVariable

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Eq for NumberVariable

impl Copy for NumberVariable

impl Debug for NumberVariable

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

Formats the value using the given formatter.

impl Hash for NumberVariable

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 NumberVariable

type Err = ParseError

The associated error which can be returned from parsing.

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

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

impl EnumProperty for NumberVariable

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

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

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