Enum OkfError 

#[non_exhaustive]
pub enum OkfError {
    Empty(String),
    NoConcepts {
        path: String,
        files: usize,
        detail: String,
    },
    AllBlocked {
        path: String,
        blocked: usize,
    },
}

Errors raised while reading a bundle.

#[non_exhaustive], on SkipReason’s reasoning and for the same subject: these name ways a directory somebody else produced fails to be a bundle, and that set is open by construction — OKF is a vendor-neutral format, so the producers are not ours to enumerate. A caller wants the message, not an exhaustive match; adding a way to fail should not be a breaking change.

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.

Empty(String)

The directory holds no markdown at all.

NoConcepts

Markdown was found, and none of it was a concept.

Deliberately fatal where a single bad document is only skipped: one unreadable file in a readable bundle is the case §11 asks consumers to tolerate, but a directory in which nothing parsed is not a bundle read badly — it is not a bundle, and importing zero concepts while exiting zero would report success for having done nothing.

Fields

path: String

The bundle root, as given.

files: usize

How many markdown files were considered.

detail: String

Up to three path: reason pairs.

AllBlocked

Every concept that parsed was refused by the screen.

Fatal on OkfError::NoConcepts’s reasoning, and for a sharper reason: a directory whose every document carries concealed instructions to a language model is not a bundle with a problem in it. Importing nothing while exiting zero would report success for having refused everything.

Fields

path: String

The bundle root, as given.

blocked: usize

How many concepts were blocked.

Trait Implementations

impl Debug for OkfError

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

Formats the value using the given formatter.

impl Display for OkfError

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

Formats the value using the given formatter.

impl Error for OkfError

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.