Enum DocsError 

#[non_exhaustive]
pub enum DocsError {
    RootMissing(String),
    IndexMalformed(String),
    MarkdownError {
        path: String,
        reason: String,
    },
    Terminal(String),
    AiDisabled,
    Assets(String),
    Search(String),
    Server(String),
    Io(Arc<Error>),
}

Every failure mode surfaced by rtb-docs.

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.

RootMissing(String)

The configured root doesn’t exist in the asset tree.

IndexMalformed(String)

_index.yaml was present but couldn’t be parsed.

MarkdownError

Markdown parse failed on a specific page.

Fields

path: String

The doc-tree-relative path that failed to parse.

reason: String

The inner parser error message.

Terminal(String)

Terminal initialisation (raw mode / alternate screen) failed.

AiDisabled

docs ask invoked without the ai feature compiled in.

Assets(String)

Wrapped rtb-assets::AssetError. Carried as a message since AssetError is not Clone and we want DocsError: Clone.

Search(String)

Wrapped tantivy::TantivyError. Carried as a message since tantivy’s error type is not Clone.

Server(String)

Wrapped hyper / axum server error.

Io(Arc<Error>)

I/O error surfaced through the cache-dir or server path.

Trait Implementations

impl Clone for DocsError

fn clone(&self) -> DocsError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocsError

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

Formats the value using the given formatter.

impl Diagnostic for DocsError

fn code(&self) -> Option<Box<dyn Display + '_>>

Unique diagnostic code that can be used to look up more information about this Diagnostic. Ideally also globally unique, and documented in the toplevel crate’s documentation for easy searching. Rust path format (foo::bar::baz) is recommended, but more classic codes like E0123 or enums will work just fine.

fn help(&self) -> Option<Box<dyn Display + '_>>

Additional help text related to this Diagnostic. Do you have any advice for the poor soul who’s just run into this issue?

fn severity(&self) -> Option<Severity>

Diagnostic severity. This may be used by ReportHandlers to change the display format of this diagnostic.

fn url<'a>(&'a self) -> Option<Box<dyn Display + 'a>>

URL to visit for a more detailed explanation/help about this Diagnostic.

fn source_code(&self) -> Option<&dyn SourceCode>

Source code to apply this Diagnostic’s Diagnostic::labels to.

fn labels(&self) -> Option<Box<dyn Iterator<Item = LabeledSpan> + '_>>

Labels to apply to this Diagnostic’s Diagnostic::source_code

fn related<'a>( &'a self, ) -> Option<Box<dyn Iterator<Item = &'a dyn Diagnostic> + 'a>>

Additional related Diagnostics.

fn diagnostic_source(&self) -> Option<&dyn Diagnostic>

The cause of the error.

impl Display for DocsError

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

Formats the value using the given formatter.

impl Error for DocsError

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<Arc<Error>> for DocsError

fn from(source: Arc<Error>) -> Self

Converts to this type from the input type.

impl From<AssetError> for DocsError

fn from(err: AssetError) -> Self

Converts to this type from the input type.

impl From<Error> for DocsError

fn from(err: Error) -> Self

Converts to this type from the input type.

impl From<TantivyError> for DocsError

fn from(err: TantivyError) -> Self

Converts to this type from the input type.