Struct NoteError

pub struct NoteError {
    pub kind: Box<NoteErrorKind>,
    pub level: DiagnosticLevel,
    pub file: Option<Url>,
    pub range: Option<Range<usize>>,
}

Error type for all Notedown operators

Fields

kind: Box<NoteErrorKind>

Actual error kind

level: DiagnosticLevel

Error level for report

file: Option<Url>

File name where error occurred

range: Option<Range<usize>>

Range offset where error occurred

Implementations

impl NoteError

pub fn set_url(&mut self, url: Url)

Set a new url for the error

pub fn set_path(&mut self, url: &Path) -> Result<()>

Set a local path for the error

pub fn set_range(&mut self, start: usize, end: usize)

Set a new range for the error

pub fn unreachable() -> Self

Constructor of NoteErrorKind::Unreachable

pub fn undefined_variable(name: impl Into<String>) -> NoteError

Constructor of NoteErrorKind::UndefinedVariable

impl NoteError

pub fn is_deprecated(&self) -> bool

Deprecated or obsolete code. Clients are allowed to rendered diagnostics with this tag strike through.

pub fn is_unnecessary(&self) -> bool

Unused or unnecessary code. Clients are allowed to render diagnostics with this tag faded out instead of having an error squiggle.

impl NoteError

pub fn syntax_error(msg: impl Into<String>) -> NoteError

Constructor of [NoteErrorKind::$t]

pub fn type_mismatch(msg: impl Into<String>) -> NoteError

Constructor of [NoteErrorKind::$t]

pub fn runtime_error(msg: impl Into<String>) -> NoteError

Constructor of [NoteErrorKind::$t]

impl NoteError

pub fn get_lsp_range(&self, text: &TextIndex) -> Option<Range>

Get the range as Range

pub fn get_lsp_tags(&self) -> Option<Vec<DiagnosticTag>>

Get the tags as DiagnosticTag

pub fn as_lsp_diagnostic(&self, text: &TextIndex) -> Diagnostic

Convert error to lsp Diagnostic

Trait Implementations

impl Debug for NoteError

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

Formats the value using the given formatter.

impl Display for NoteError

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

Formats the value using the given formatter.

impl Error for NoteError

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<()> for NoteError

fn from(_: ()) -> Self

Converts to this type from the input type.

impl<R> From<Error<R>> for NoteError

where R: Debug,

fn from(e: Error<R>) -> Self

Converts to this type from the input type.

impl From<Error> for NoteError

fn from(e: Error) -> Self

Converts to this type from the input type.

impl From<Error> for NoteError

fn from(e: Error) -> Self

Converts to this type from the input type.

impl From<Error> for NoteError

fn from(e: Error) -> Self

Converts to this type from the input type.

impl From<Error> for NoteError

fn from(e: Error) -> Self

Converts to this type from the input type.

impl From<Error> for NoteError

fn from(e: Error) -> Self

Converts to this type from the input type.

impl From<Error> for NoteError

fn from(e: Error) -> Self

Converts to this type from the input type.

impl From<Error> for NoteError

fn from(e: Error) -> Self

Converts to this type from the input type.

impl From<Error> for NoteError

fn from(e: Error) -> Self

Converts to this type from the input type.

impl<R> From<ErrorVariant<R>> for NoteError

where R: Debug,

fn from(e: ErrorVariant<R>) -> Self

Converts to this type from the input type.

impl From<Infallible> for NoteError

fn from(_: Infallible) -> Self

Converts to this type from the input type.

impl From<ParseError> for NoteError

fn from(e: ParseError) -> Self

Converts to this type from the input type.

impl From<ParseError> for NoteError

fn from(e: ParseError) -> Self

Converts to this type from the input type.

impl From<TryFromBigIntError<BigInt>> for NoteError

fn from(e: TryFromBigIntError<BigInt>) -> Self

Converts to this type from the input type.