Enum DocsKitError 

pub enum DocsKitError {
    NavParse(Error),
    BlogManifestParse(Error),
    OpenApi {
        prefix: String,
        error: OpenApiError,
    },
}

Errors produced when building a DocsRegistry or BlogRegistry from configuration.

Variants

NavParse(Error)

_nav.json failed to parse.

BlogManifestParse(Error)

_blog.json failed to parse.

OpenApi

An OpenAPI spec failed to parse.

Fields

prefix: String

URL prefix the spec was registered under.

error: OpenApiError

The underlying parse error.

Trait Implementations

impl Debug for DocsKitError

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

Formats the value using the given formatter.

impl Display for DocsKitError

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

Formats the value using the given formatter.

impl Error for DocsKitError

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.