Struct Citation 

pub struct Citation {
    pub id: Option<String>,
    pub note_number: Option<u32>,
    pub mode: CitationMode,
    pub position: Option<Position>,
    pub suppress_author: bool,
    pub prefix: Option<String>,
    pub suffix: Option<String>,
    pub items: Vec<CitationItem>,
    pub grouped: bool,
    pub sentence_start: bool,
}

A citation containing one or more references.

Fields

id: Option<String>

The citation ID (optional, for tracking).

note_number: Option<u32>

Note number for footnote/endnote styles. Assigned by the document processor, not the citation processor.

mode: CitationMode

Citation mode: integral (narrative) vs non-integral (parenthetical). Only relevant for author-date styles.

position: Option<Position>

Position of this citation in the document flow. Detected automatically by the processor or set explicitly by the caller.

suppress_author: bool

Suppress the author name across all items in this citation. Used when the author is already named in the prose: “Smith argues (2020)”. Applies uniformly to all items — per-item suppression is not supported because mixed-visibility citations are typographically incoherent.

prefix: Option<String>

Prefix text before all citation items.

suffix: Option<String>

Suffix text after all citation items.

items: Vec<CitationItem>

The citation items (references being cited).

grouped: bool

If true, the entire citation is a single dynamic compound set.

The first item acts as the head and subsequent items are merged as tails in the bibliography. Ignored for non-numeric (compound-numeric) styles. Item order is preserved and sorting is suppressed when this flag is set.

sentence_start: bool

Signal that this citation cluster opens a sentence, so its leading character should be capitalized (e.g. “see also …” → “See also …”).

The processor cannot infer sentence context from rendered text; the host (document pipeline, WASM bridge, or editor) supplies this flag explicitly — mirroring LaTeX’s capitalized cite commands (\Citet, \Parencite, \Textcite). When false (the default), no capitalization transform is applied.

Implementations

impl Citation

pub fn simple(id: &str) -> Citation

Create a simple single-item citation.

Convenience constructor for a citation with a single reference ID and default settings.

Trait Implementations

impl Clone for Citation

fn clone(&self) -> Citation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Citation

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

Formats the value using the given formatter.

impl Default for Citation

fn default() -> Citation

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Citation

fn deserialize<__D>( __deserializer: __D, ) -> Result<Citation, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<CitationOccurrence> for Citation

fn from(occ: CitationOccurrence) -> Self

Converts to this type from the input type.

impl Serialize for Citation

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.