Enum Error

pub enum Error {
    Io(Error),
    InvalidFormat,
    Yaml(Error),
    IsNotDir(PathBuf),
    IsNotFile(PathBuf),
    FromUtf8(FromUtf8Error),
}

Main error type for Obsidian parsing operations

Variants

Io(Error)

I/O operation failed (file reading, directory traversal, etc.)

InvalidFormat

Invalid frontmatter format detected

Occurs when:

• Frontmatter delimiters are incomplete (--- missing)
• Content between delimiters is empty

Example

Parsing a file with malformed frontmatter:

---
incomplete yaml
// Missing closing ---

Yaml(Error)

YAML parsing error in frontmatter properties

Example

Parsing invalid YAML syntax:

---
key: @invalid_value
---

IsNotDir(PathBuf)

Expected a directory path

Example

use obsidian_parser::prelude::*;

// Will fail if passed a file path
Vault::open_default("notes.md").unwrap();

IsNotFile(PathBuf)

Expected a file path

Example

use obsidian_parser::prelude::*;

// Will fail if passed a directory path
ObFileOnDisk::from_file_default("/home/test");

FromUtf8(FromUtf8Error)

File contains invalid UTF-8 encoding

Obsidian requires UTF-8 encoded files. This error occurs when binary or improperly encoded files are encountered.

Example

// Create invalid UTF-8 file
let mut f = File::create("invalid.md").unwrap();
f.write_all(&[0xff, 0xfe, 0xfd]).unwrap();

// Parsing will fail
ObFileInMemory::from_file_default("invalid.md").unwrap_err();

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.

impl From<Error> for Error

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<FromUtf8Error> for Error

fn from(source: FromUtf8Error) -> Self

Converts to this type from the input type.