Enum DocumentError 

#[non_exhaustive]
pub enum DocumentError {
    UnterminatedFrontmatter,
    FrontmatterNotMapping,
    InvalidYaml(YamlError),
    MissingKeys(Vec<String>),
    InvalidConceptId(ConceptIdError),
}

Errors raised when parsing or validating a single OKF concept document.

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.

UnterminatedFrontmatter

The frontmatter opened with --- but no closing --- was found.

FrontmatterNotMapping

The frontmatter block did not contain a YAML mapping.

InvalidYaml(YamlError)

The YAML frontmatter could not be parsed.

MissingKeys(Vec<String>)

Required frontmatter keys are missing or empty.

InvalidConceptId(ConceptIdError)

The file’s path could not be turned into a valid concept id.

Trait Implementations

impl Clone for DocumentError

fn clone(&self) -> DocumentError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocumentError

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

Formats the value using the given formatter.

impl Display for DocumentError

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

Formats the value using the given formatter.

impl Eq for DocumentError

impl Error for DocumentError

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<ConceptIdError> for DocumentError

fn from(e: ConceptIdError) -> Self

Converts to this type from the input type.

impl From<YamlError> for DocumentError

fn from(e: YamlError) -> Self

Converts to this type from the input type.

impl PartialEq for DocumentError

fn eq(&self, other: &DocumentError) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for DocumentError