Skip to main content

RefsInput

Enum RefsInput 

Source
pub enum RefsInput {
    Path(String),
    Yaml(String),
    Json(Value),
    Biblatex(String),
}
Expand description

A refs input that can be resolved locally or by an external resolver.

This union type allows callers to supply reference data by local file path, inline YAML, inline JSON, or inline BibLaTeX. Enables citum-server and bindings to accept references from files (e.g., via pipe transport from LaTeX or Emacs).

Supported tagged-object shapes over JSON/RPC:

{"kind": "path",     "value": "/abs/path/refs.yaml"}
{"kind": "path",     "value": "/abs/path/refs.bib"}  // .bib detected by extension
{"kind": "yaml",     "value": "references:\n  - id: …"}
{"kind": "json",     "value": {"id": { … }}}
{"kind": "biblatex", "value": "@book{key, title={…}, …}"}

Variants§

§

Path(String)

Local filesystem path to a refs file.

YAML/JSON/CBOR extensions are loaded as native Citum refs; .bib extensions are parsed as BibLaTeX.

§

Yaml(String)

Inline YAML refs string.

§

Json(Value)

Inline JSON map of reference objects.

§

Biblatex(String)

Inline BibLaTeX (.bib) content.

Implementations§

Source§

impl RefsInput

Source

pub fn resolve_local(&self) -> Result<Bibliography, FormatDocumentError>

Resolve refs input locally from Path, Yaml, Json, or Biblatex variants.

For Path inputs, .bib files are parsed as BibLaTeX; all other extensions are parsed as native Citum YAML/JSON/CBOR.

§Errors

Returns error for refs input filesystem or parse failures.

Trait Implementations§

Source§

impl Clone for RefsInput

Source§

fn clone(&self) -> RefsInput

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for RefsInput

Source§

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

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

impl<'de> Deserialize<'de> for RefsInput

Source§

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for RefsInput

Source§

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where S: Serializer,

Serialize this value into the given Serde serializer. 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> 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.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

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