Skip to main content

RunState

Struct RunState 

Source
pub struct RunState { /* private fields */ }
Expand description

Mutable per-render-run state: citation numbering, cite-order tracking, and dynamic (cite-time) compound-group membership.

Create with Processor::begin_run; populate via registration methods (&self, &mut RunState); consume via finalize before rendering.

Clone is provided for long-lived callers (e.g. the FFI session handle) that need to render a bibliography from a snapshot of the current state without pausing ongoing citation registration on the original RunState. Implemented by hand (rather than derived) because RwLock<T> is not Clone even when T is; the impl below clones the locked contents into fresh locks instead.

Implementations§

Source§

impl RunState

Source

pub fn finalize(self) -> FinalizedRun

Complete the registration phase, producing a FinalizedRun.

This is a plain newtype wrap with no additional computation; it exists purely as a compile-time marker that registration for this run is considered complete, so rendering methods that require citation order/numbering can require &FinalizedRun instead of &RunState.

Trait Implementations§

Source§

impl Clone for RunState

Source§

fn clone(&self) -> Self

Snapshot the current state, including the interior-mutable citation numbers and first-note map, into a fresh, independently-lockable copy.

1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for RunState

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for RunState

Source§

fn default() -> Self

Returns the “default value” for a type. 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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.