Struct Citation 

pub struct Citation {
    pub refs: Vec<String>,
    pub locator: Option<String>,
    pub locator_type: Option<LocatorType>,
    pub prefix: Option<String>,
    pub suffix: Option<String>,
    pub suppress_author: bool,
}

An inline citation reference.

Supports both single and multi-reference citations (e.g., [smith2023; jones2024]).

Backward Compatibility

Deserializes from both the old singular "ref" (string) format and the new "refs" (array) format.

Fields

refs: Vec<String>

References to bibliography entry IDs.

locator: Option<String>

Page or location within the reference.

locator_type: Option<LocatorType>

Locator type (page, chapter, section, etc.).

prefix: Option<String>

Text before the citation (e.g., “see”).

suffix: Option<String>

Text after the citation (e.g., “for details”).

suppress_author: bool

Suppress author name in citation.

Implementations

impl Citation

pub fn new(reference: impl Into<String>) -> Self

Create a new citation with a single reference.

pub fn multi(refs: Vec<String>) -> Self

Create a citation with multiple references (e.g., [smith2023; jones2024]).

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

Get the first reference, if any.

pub fn refs(&self) -> &[String]

Get all references.

pub fn with_page(self, page: impl Into<String>) -> Self

Set page locator.

pub fn with_locator( self, locator: impl Into<String>, locator_type: LocatorType, ) -> Self

Set locator with type.

pub fn with_prefix(self, prefix: impl Into<String>) -> Self

Set prefix text.

pub fn with_suffix(self, suffix: impl Into<String>) -> Self

Set suffix text.

pub const fn suppress_author(self) -> Self

Suppress author name.

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

Formats the value using the given formatter.

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

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl PartialEq for Citation

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

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

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 Citation

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

Serialize this value into the given Serde serializer.

impl Eq for Citation

impl StructuralPartialEq for Citation