Enum Error 

#[non_exhaustive]
pub enum Error {
    Io {
        path: PathBuf,
        source: Error,
    },
    Config {
        path: PathBuf,
        source: Error,
    },
    UnknownRelationSource {
        external: String,
        from: String,
    },
    InvalidExternalId {
        id: String,
    },
    ExternalKindIsSurveyed {
        id: String,
        kind: String,
        surveyed: String,
    },
    DuplicateId {
        id: String,
        first: String,
        second: String,
    },
    UnknownThemeKind {
        kind: String,
        have: String,
    },
    UnknownTopLevel {
        path: PathBuf,
        entry: String,
        known: String,
    },
    PinMismatch {
        path: PathBuf,
        pinned: String,
        running: String,
    },
    NoFrontend {
        root: PathBuf,
    },
    Frontend {
        frontend: String,
        source: Box<dyn Error + Send + Sync + 'static>,
    },
}

Anything the core, a front-end, or the config can get wrong.

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.

Io

Fields

path: PathBuf

source: Error

Config

asbuilt.toml did not parse or had a key the schema rejects.

Fields

path: PathBuf

source: Error

UnknownRelationSource

An [[externals.relations]] from that names no generated element and no sibling external. A typo here is an error, not a diagram that quietly omits an edge.

Fields

external: String

from: String

InvalidExternalId

An [[externals]] id that is not a LikeC4 identifier as written.

Fields

id: String

ExternalKindIsSurveyed

An [[externals]] kind that is one the survey generates; surveyed lists them.

Fields

id: String

kind: String

surveyed: String

DuplicateId

Two model ids that become the same LikeC4 identifier once - maps to _ and a leading digit is prefixed.

Fields

id: String

first: String

second: String

UnknownThemeKind

A [theme] key naming an element kind the surveyed model does not have; a typo would otherwise style nothing, silently.

Fields

kind: String

have: String

UnknownTopLevel

A top-level asbuilt.toml entry that is neither one of asbuilt’s own tables nor a front-end’s: [rsut], [[external]] for [[externals]], or a key such as title = ... that belongs under [docs]. It would otherwise be ignored, silently. entry is written as it appears in the file.

Fields

path: PathBuf

entry: String

known: String

PinMismatch

asbuilt = "X.Y.Z" pins a release other than the one running. A survey is only meaningful against the release that wrote the model, so every command stops here rather than report the other release’s output as drift.

Fields

path: PathBuf

pinned: String

running: String

NoFrontend

No front-end recognized the root.

Fields

root: PathBuf

Frontend

A front-end failed; the source says which file or module.

Fields

frontend: String

source: Box<dyn Error + Send + Sync + 'static>

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

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.