Struct DocumentSession 

pub struct DocumentSession { /* private fields */ }

Stateful facade over whole-document citation rendering.

The session caches its inputs in resolved form: the style is stored already resolved (see DocumentSession::new) and references are parsed once in DocumentSession::put_references. Each mutation still clones both into a fresh Processor (including disambiguation-hint calculation) and re-renders every citation plus the bibliography — incremental re-rendering is not yet implemented.

Implementations

impl DocumentSession

pub fn new( style: Style, _style_input: StyleInput, locale: Option<String>, output_format: OutputFormatKind, document_options: Option<DocumentOptions>, ) -> Self

Create a session with an already-resolved style.

pub fn version(&self) -> u64

Return the current session version.

pub fn put_references( &mut self, refs: RefsInput, ) -> Result<(), DocumentSessionError>

Replace the full reference set used by this session.

The input is parsed here, once, and the resolved bibliography (plus its reference-level warnings) is cached for all subsequent mutations and previews. Calling this again replaces the cache wholesale.

Errors

Returns an error when the reference input cannot be parsed.

pub fn set_nocite( &mut self, ids: Vec<String>, ) -> Result<SessionMutationResult, DocumentSessionError>

Set the nocite list and re-render the session bibliography.

Nocite IDs appear in the bibliography alongside cited refs but produce no formatted_citations entry. IDs absent from the current reference set emit a nocite_missing_ref warning and are silently dropped.

Errors

Returns an error when re-rendering the session output fails.

pub fn insert_citations_batch( &mut self, citations: Vec<CitationOccurrence>, ) -> Result<SessionMutationResult, DocumentSessionError>

Replace the full ordered citation list.

Errors

Returns an error when recomputing the formatted session output fails.

pub fn insert_citation( &mut self, citation: CitationOccurrence, position: Option<CitationInsertPosition>, ) -> Result<SessionMutationResult, DocumentSessionError>

Insert a citation at the requested position.

Errors

Returns an error when the requested position is invalid or rendering fails.

pub fn update_citation( &mut self, citation_id: &str, citation: CitationOccurrence, position: Option<CitationInsertPosition>, ) -> Result<SessionMutationResult, DocumentSessionError>

Update an existing citation, optionally moving it to a new position.

Errors

Returns an error when the citation does not exist, the requested position is invalid, or rendering fails.

pub fn delete_citation( &mut self, citation_id: &str, ) -> Result<SessionMutationResult, DocumentSessionError>

Delete a citation by ID.

Errors

Returns an error when the citation does not exist or rendering fails.

pub fn preview_citation( &self, items: Vec<CitationOccurrenceItem>, mode: Option<CitationMode>, position: Option<CitationInsertPosition>, ) -> Result<PreviewCitationResult, DocumentSessionError>

Render a citation preview without mutating session state.

Errors

Returns an error when the requested preview position is invalid or rendering fails.

pub fn get_citations(&self) -> Vec<FormattedCitation>

Return the current formatted citations.

pub fn get_bibliography(&self) -> Option<FormattedBibliography>

Return the current bibliography, if a mutation has rendered one.

Trait Implementations

impl Clone for DocumentSession

fn clone(&self) -> DocumentSession

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocumentSession

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

Formats the value using the given formatter.