Skip to main content

CiteError

Enum CiteError 

Source
#[non_exhaustive]
pub enum CiteError { Parse { file: Option<PathBuf>, message: String, }, DuplicateKey { key: String, first_file: PathBuf, second_file: PathBuf, }, UnknownCitation { key: String, }, Io { path: PathBuf, source: Error, }, }
Expand description

Errors that can occur while loading a bibliography or processing citations.

This error type is non-exhaustive and may gain new variants in future releases.

§Variants

  • Parse: a .bib file’s contents are malformed. file is None when the parser was handed a string directly rather than a file on disk.
  • DuplicateKey: one citation key is defined by two .bib files in the same directory, so which entry a citation refers to is ambiguous.
  • UnknownCitation: a [@key] citation names a key no loaded .bib file defines.
  • Io: a .bib file or its directory could not be read.

Variants (Non-exhaustive)§

This enum is marked as 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.
§

Parse

Malformed .bib contents. file is None when parsing a bare string.

Fields

§file: Option<PathBuf>

The .bib file the malformed content came from, when it came from one.

§message: String

What was malformed.

§

DuplicateKey

One citation key defined by two files in the same bibliography directory.

Fields

§key: String

The key defined twice.

§first_file: PathBuf

The file that defined it first.

§second_file: PathBuf

The file that redefined it.

§

UnknownCitation

A citation naming a key no loaded .bib file defines.

Fields

§key: String

The undefined key, as written in the citation.

§

Io

A .bib file or bibliography directory could not be read.

Fields

§path: PathBuf

The path that could not be read.

§source: Error

The underlying I/O failure.

Trait Implementations§

Source§

impl Debug for CiteError

Source§

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

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

impl Display for CiteError

Source§

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

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

impl Error for CiteError

Source§

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

Returns the lower-level source of this error, if any. Read more
1.0.0 · Source§

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

1.0.0 · Source§

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

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

Source§

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. 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> 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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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.