Skip to main content

citum_engine/api/
mod.rs

1/*
2SPDX-License-Identifier: MIT OR Apache-2.0
3SPDX-FileCopyrightText: © 2023-2026 Bruce D'Arcus and Citum contributors
4*/
5
6//! Interactive document-level API for batch citation formatting.
7//!
8//! This module provides the Tier 1 `format_document` API, enabling whole-document
9//! citation and bibliography rendering with proper context (note positions, ibid
10//! detection, disambiguation).
11
12mod document;
13pub mod forward_compat;
14mod refs_input;
15mod session;
16mod style_input;
17mod types;
18
19pub use document::{
20    FormatDocumentError, FormatDocumentRequest, FormatDocumentResult, apply_style_overrides,
21    format_document, format_document_with_resolver, format_document_with_style,
22    unknown_enum_warnings, unknown_reference_class_warnings,
23};
24pub use forward_compat::{UnknownFieldPath, collect_unknown_field_paths};
25pub use refs_input::RefsInput;
26pub use session::{
27    CitationInsertPosition, DocumentSession, DocumentSessionError, OpenSessionResult,
28    PreviewCitationResult, SessionMutationResult,
29};
30pub use style_input::StyleInput;
31pub use types::{
32    AbbreviationMap, AnnotationFormat, AnnotationStyle, BibliographyBlockRequest,
33    BibliographyEntry, CitationOccurrence, CitationOccurrenceItem, DocumentOptions, EntryMetadata,
34    FormattedBibliography, FormattedBibliographyBlock, FormattedCitation, OutputFormatKind,
35    Warning, WarningLevel,
36};