citum-engine 0.54.0

Citum citation and bibliography processor
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55

/*
SPDX-License-Identifier: MIT OR Apache-2.0
SPDX-FileCopyrightText: © 2023-2026 Bruce D'Arcus
*/

//! Shared parameter types for grouped citation rendering.

/// Parameters for grouped citation rendering.
///
/// Bundles together related parameters that would otherwise lead to
/// `too_many_arguments` lint violations. This struct is used to pass
/// consistent rendering configuration to fallback functions.
#[derive(Debug)]
pub struct GroupRenderParams<'a> {
    /// The citation spec containing templates and configuration.
    pub spec: &'a citum_schema::CitationSpec,
    /// The citation mode (integral or non-integral).
    pub mode: &'a citum_schema::citation::CitationMode,
    /// Delimiter between items within a citation.
    pub intra_delimiter: &'a str,
    /// Whether to suppress author output.
    pub suppress_author: bool,
    /// The citation position (e.g., ibid, subsequent).
    pub position: Option<&'a citum_schema::citation::Position>,
    /// Optional note-start text-case policy for note-style repeated-note output.
    pub note_start_text_case: Option<citum_schema::NoteStartTextCase>,
}

/// Parameters for rendering a template with a citation number.
///
/// Bundles all rendering configuration into a single struct so that
/// `process_template_with_number` and its format-generic variant can
/// accept a single argument instead of ten, eliminating the need for
/// `#[allow(clippy::too_many_arguments)]` suppressions.
#[derive(Debug)]
pub struct TemplateRenderParams<'a> {
    /// The template components to render.
    pub template: &'a [citum_schema::template::TemplateComponent],
    /// The rendering context (citation or bibliography).
    pub context: crate::values::RenderContext,
    /// The citation mode (integral or non-integral).
    pub mode: citum_schema::citation::CitationMode,
    /// Whether to suppress the author component.
    pub suppress_author: bool,
    /// The citation number for numeric styles.
    pub citation_number: usize,
    /// The raw citation locator if present.
    pub locator_raw: Option<&'a citum_schema::citation::CitationLocator>,
    /// The citation position (e.g., ibid, subsequent).
    pub position: Option<&'a citum_schema::citation::Position>,
    /// Optional note-start text-case policy for citation templates.
    pub note_start_text_case: Option<citum_schema::NoteStartTextCase>,
    /// Whether the author was rendered in integral form in the prose anchor.
    pub integral_name_state: Option<citum_schema::citation::IntegralNameState>,
}