Enum ParseError 

#[non_exhaustive]
pub enum ParseError {
    NoIdentifier {
        entry_key: Option<String>,
    },
    UnsupportedIdentifier {
        kind: &'static str,
        value: String,
        entry_key: Option<String>,
    },
    SoftwareUrl {
        url: String,
        entry_key: Option<String>,
    },
    InvalidRef {
        raw: String,
        entry_key: Option<String>,
        source: RefParseError,
    },
    Decode {
        format: &'static str,
        message: String,
    },
    UnsupportedFormat {
        format: &'static str,
    },
}

Why a single bibliography entry failed to produce a Ref.

Closed-enum so the failure-class can be exposed at the docs/ERRORS.md §3 INVALID_REF surface without leaking parser internals.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

NoIdentifier

The line did not contain a doi: / arxiv: / bare-DOI / bare-arXiv id — empty (after trimming) or just a comment. Plain-refs path filters these out silently; CSL-JSON path emits this when an entry has no resolvable identifier.

Fields

entry_key: Option<String>

The source bibliography’s citation key, when known.

UnsupportedIdentifier

The entry DOES carry an identifier, and it is one doiget recognises and resolves only with a request: a PMID / PMCID, through the DOI PubMed lists for it (#500, crate::pubmed::resolve_entries).

Distinct from Self::NoIdentifier because the two send a reader in opposite directions. “entry has no DOI / arXiv id” is accurate about what the parser did and wrong about the entry: a PubMed-exported .bib record carrying pmid = {9659853} is not deficient, and a user who believes it is will go and edit a bibliography that was fine. The missing piece is on doiget’s side.

Surfaces as NOT_IMPLEMENTED rather than INVALID_REF: the input is valid and the support is absent, and the two carry different advice – “wait for a release” versus “correct your input” (ADR-0055).

Fields

kind: &'static str

Human-facing name of the identifier class, e.g. "PMID".

value: String

The identifier as written in the entry.

entry_key: Option<String>

The source bibliography’s citation key, when known.

SoftwareUrl

The entry has no DOI or arXiv id but is software on GitHub: its url is a repository or release (#614). verify checks it still resolves, and doiget cite <url> renders it as @software.

Fields

url: String

The GitHub URL as written in the entry.

entry_key: Option<String>

The source bibliography’s citation key, when known.

InvalidRef

The identifier was present but Ref::parse rejected it (malformed DOI suffix, invalid arXiv id shape, etc.).

Fields

raw: String

The raw identifier string the parser saw.

entry_key: Option<String>

The source bibliography’s citation key, when known.

source: RefParseError

The structured Ref::parse failure.

Decode

The whole input did not deserialise — CSL-JSON that is not a JSON array, top-level malformed JSON, etc. This is a whole-input failure, not a per-entry failure; callers receive it as the sole Err element of the result iterator.

Fields

format: &'static str

Which parser branch produced the failure ("csl-json" / "bibtex").

message: String

serde_json::Error::to_string().

UnsupportedFormat

Format requested or detected, but no parser for it is shipped. Retained as a forward-compatible variant for input shapes not yet implemented (e.g. a future RIS adapter); the bibtex and csl-json paths are both live today.

Fields

format: &'static str

The format token naming the unsupported shape.

Trait Implementations

impl Clone for ParseError

fn clone(&self) -> ParseError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ParseError

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

Formats the value using the given formatter.

impl Display for ParseError

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

Formats the value using the given formatter.

impl Eq for ParseError

impl Error for ParseError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl PartialEq for ParseError

fn eq(&self, other: &ParseError) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ParseError