Struct BibParseError 

pub struct BibParseError {
    kind: BibParseErrorKind,
    offset: usize,
}

A recoverable BibTeX parse error: a BibParseErrorKind plus the byte offset into the original input where the problem was detected.

The offset is a byte index, matching the convention mos-core SourceSpans use, so a future citation slice can turn one of these into a compiler Diagnostic without re-deriving positions. Use line_col for a 1-based line/column pair.

Examples

use mos_bib::{BibParseErrorKind, parse_bibtex};

let err = parse_bibtex("article{x}").unwrap_err();
assert_eq!(err.kind(), BibParseErrorKind::ExpectedAt);
assert_eq!(err.offset(), 0);

Fields

kind: BibParseErrorKind

offset: usize

Implementations

impl BibParseError

pub(crate) const fn new(kind: BibParseErrorKind, offset: usize) -> Self

Construct an error of kind at byte offset. Crate-internal: the parser is the only place that mints these.

pub const fn kind(&self) -> BibParseErrorKind

The kind of parse failure.

pub const fn offset(&self) -> usize

The byte offset into the parsed input where the error was detected.

pub fn line_col(&self, src: &str) -> (usize, usize)

The 1-based (line, column) of this error within src.

src must be the input passed to parse_bibtex; columns count Unicode scalar values. Use to_diagnostic or From<BibParseError> for CoreError to bridge into mos-core diagnostics.

Examples

use mos_bib::parse_bibtex;

let src = "@article{ok}\n@bad";
let err = parse_bibtex(src).unwrap_err();
assert_eq!(err.line_col(src), (2, 5));

pub fn to_diagnostic(&self, file: impl Into<PathBuf>) -> Diagnostic

Convert this error into a mos-core [Diagnostic] anchored in file.

The diagnostic carries the MOS0043 code and a zero-width [SourceSpan] at offset, so a malformed .bib reported here renders through the standard compiler pipeline. The infallible From<BibParseError> for CoreError conversion is the span-less equivalent for boundaries without a source path.

Examples

use mos_bib::parse_bibtex;

let err = parse_bibtex("oops").unwrap_err();
let diagnostic = err.to_diagnostic("refs.bib");
assert_eq!(diagnostic.def().code().to_string(), "MOS0043");

Trait Implementations

impl Clone for BibParseError

fn clone(&self) -> BibParseError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BibParseError

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

Formats the value using the given formatter.

impl Display for BibParseError

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

Formats the value using the given formatter.

impl Error for BibParseError

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 From<BibParseError> for CoreError

fn from(err: BibParseError) -> Self

Converts to this type from the input type.

impl PartialEq for BibParseError

fn eq(&self, other: &BibParseError) -> 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 Eq for BibParseError

impl StructuralPartialEq for BibParseError