Struct ProcHints 

pub struct ProcHints {

    pub disamb_condition: bool,
    pub group_index: usize,
    pub group_length: usize,
    pub group_key: String,
    pub expand_given_names: bool,
    pub min_names_to_show: Option<usize>,
    pub citation_number: Option<usize>,
    pub citation_sub_label: Option<String>,
    pub position: Option<Position>,
    pub integral_name_state: Option<IntegralNameState>,
    pub org_abbreviation_state: Option<IntegralNameState>,
    pub first_reference_note_number: Option<u32>,
    pub suppress_disambiguation_title: bool,
}

Processing hints computed before rendering a reference or citation item.

Fields

disamb_condition: bool

Whether disambiguation is active (triggers year-suffix).

group_index: usize

Index in the disambiguation group (1-based).

group_length: usize

Total size of the disambiguation group.

group_key: String

The grouping key used.

expand_given_names: bool

Whether to expand given names for disambiguation.

min_names_to_show: Option<usize>

Minimum number of names to show to resolve ambiguity (overrides et-al-use-first).

citation_number: Option<usize>

Citation number for numeric citation styles (1-based).

citation_sub_label: Option<String>

Optional sub-label for compound numeric citation addressing (e.g., “a” in “1a”).

position: Option<Position>

Citation position (first, subsequent, ibid, etc.).

integral_name_state: Option<IntegralNameState>

Explicit integral citation name-memory state for this rendered item.

org_abbreviation_state: Option<IntegralNameState>

Explicit org-abbreviation state for this rendered item.

first_reference_note_number: Option<u32>

First note number in which this reference was cited (note styles only). Set for subsequent-position citations; None otherwise.

suppress_disambiguation_title: bool

When true, suppress a disambiguate_only title component. Set when first_reference_note_number is present — the note number already identifies the work; the disambiguating short title is redundant.

Trait Implementations

impl Clone for ProcHints

fn clone(&self) -> ProcHints

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProcHints

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

Formats the value using the given formatter.

impl Default for ProcHints

fn default() -> ProcHints

Returns the “default value” for a type.