Skip to main content

TemplateRenderParams

Struct TemplateRenderParams 

Source
pub struct TemplateRenderParams<'a> {
    pub template: &'a [TemplateComponent],
    pub context: RenderContext,
    pub mode: CitationMode,
    pub suppress_author: bool,
    pub citation_number: usize,
    pub locator_raw: Option<&'a CitationLocator>,
    pub position: Option<&'a Position>,
    pub note_start_text_case: Option<NoteStartTextCase>,
    pub integral_name_state: Option<IntegralNameState>,
    pub org_abbreviation_state: Option<IntegralNameState>,
}
Expand description

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.

Fields§

§template: &'a [TemplateComponent]

The template components to render.

§context: RenderContext

The rendering context (citation or bibliography).

§mode: CitationMode

The citation mode (integral or non-integral).

§suppress_author: bool

Whether to suppress the author component.

§citation_number: usize

The citation number for numeric styles.

§locator_raw: Option<&'a CitationLocator>

The raw citation locator if present.

§position: Option<&'a Position>

The citation position (e.g., ibid, subsequent).

§note_start_text_case: Option<NoteStartTextCase>

Optional note-start text-case policy for citation templates.

§integral_name_state: Option<IntegralNameState>

Whether the author was rendered in integral form in the prose anchor.

§org_abbreviation_state: Option<IntegralNameState>

Org abbreviation state for org-name formatting.

Trait Implementations§

Source§

impl<'a> Debug for TemplateRenderParams<'a>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.