CRDriver is the main set of APIs.class CRDriver The central API for interacting with CiteprocRsKit.
typealias CROutputFormat Enum, format to write output in: .html, .rtf, .plain
Overview
See citeproc-rs for more information.
Framework Citeproc
CiteprocRsKit
A wrapper for
citeproc-rs in Swift.Framework
- Citeproc
Rs Kit
Topics
Fundamentals
Error handling
Nearly every operation in the entire library is explicitly
throws; this means even the smallest error on the FFI boundary results in a stack trace. Notably, every panic that unwinds to the FFI boundary is caught and thrown as a Swift exception, with the backtrace logged to your logger of choice.struct CRError Holds an error code and an error message, usually from
citeproc-rs’ end, but sometimes generated in the Swift bindings.typealias CRErrorCode Enum, error code directly from citeproc-rs’ ffi layer (.nullPointer, .caughtPanic, .serdeJson, etc).
Citation clusters
A cluster is a list of cites. Each cite contains a string that should match one of the References known to the Driver. The cluster as a whole is identified with either a string or a
UInt32.Discussion
See also: insert, and other methods on CRDriver.
class CRClusterHandle A structure for describing a cluster to submit to citeproc-rs.
typealias CRClusterId An integer (
UInt32) representation of a cluster ID.struct CRCite A convenient struct to hold details of a single cite within a cluster.
Document flow
Where in the document are all these clusters?
struct CRClusterPosition A cluster position for use in
setClusterOrder(positions:) Logging
CiteprocRsKit is capable of forwarding all of
citeproc-rs’ logs to the destination of your choice.protocol CRLog A protocol for logging implementations that can print (or ignore) a a message logged via the Rust
log crate.struct CRLogger A logging backend to install globally, that citeproc-rs will use for all its logging. You can only install a logger once.
class CROSLogger A logger that uses the Unified Logging system introduced in 2016.
typealias CRLogLevel .error = 1, .warn, .info, .debug, .trace: Log severity levels from the Rust log crate.typealias CRLevelFilter .off, .error, .warn, .info, .debug, .trace: Log level filters from the Rust log crate. .off means “no logs should be logged”; .warn means “errors and warnings should be logged”.References
To pass reference data into
CRDriver, you can use either raw JSON Data or any kind of Encodable value that produces CSL-JSON. For convenience a set of types that do that is provided.enum CslVariable An enum representing a single CSL variable.