Skip to main content

DeclarativeError

Enum DeclarativeError 

Source
pub enum DeclarativeError {
    InvalidYaml(String),
    InvalidDocument(String),
    UnsupportedVersion(String),
    RetiredVersion,
    InvalidKind(String),
    InvalidSchema(String),
    InvalidBody(String),
    InvalidTextSpec(String),
    InvalidConfig(String),
    CodeContractRef {
        path: String,
        target: String,
    },
    ContractRefRead {
        target: String,
        reason: String,
    },
    FileRead {
        path: String,
        reason: String,
    },
}
Expand description

A declarative document that could not be compiled into a contract / config.

Variants§

§

InvalidYaml(String)

the YAML text itself does not parse

§

InvalidDocument(String)

the document parses but is not a mapping with the required envelope

§

UnsupportedVersion(String)

an mcVersion outside the supported set — never best-effort parsed

§

RetiredVersion

mcVersion: 1 — retired; markdown-contract migrate rewrites a v1 document

§

InvalidKind(String)

a kind that is neither contract nor config

§

InvalidSchema(String)

a schema node outside the closed v2 vocabulary

§

InvalidBody(String)

a body-grammar node outside the v2 DSL (or a build-time grammar violation)

§

InvalidTextSpec(String)

a requires: / forbids: match spec outside the closed vocabulary (or a duplicate / contradiction)

§

InvalidConfig(String)

a config document outside the v2 DSL

§

CodeContractRef

a config contract ref that is not a .yaml / .yml file, such as a .ts module

Fields

§path: String

where the ref sits in the config, such as rules[0].contract

§target: String

the file the ref resolves to, after the contracts name lookup

§

ContractRefRead

a referenced contract file could not be read

Fields

§target: String

the file the ref resolves to

§reason: String

why the read failed

§

FileRead

a config or contract file passed to a *_file loader could not be read

Fields

§path: String

the file

§reason: String

why the read failed

Trait Implementations§

Source§

impl Debug for DeclarativeError

Source§

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

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

impl Display for DeclarativeError

Source§

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

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

impl Error for DeclarativeError

1.30.0 · 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.