Skip to main content

MarkdownFile

Struct MarkdownFile 

Source
pub struct MarkdownFile<T: DeserializeOwned> {
    pub frontmatter: Option<T>,
    pub content: String,
}
Expand description

Represents a parsed markdown file with optional frontmatter

Fields§

§frontmatter: Option<T>

Parsed frontmatter (if present)

§content: String

The content after frontmatter

Implementations§

Source§

impl<T: DeserializeOwned + Send + 'static> MarkdownFile<T>

Source

pub fn parse(path: impl AsRef<Path>) -> Result<Self, ParseError>

Source

pub fn list(dir: impl AsRef<Path>) -> Result<Vec<PathBuf>, Error>

List all markdown files in a directory

Source

pub fn from_file(path: impl AsRef<Path>) -> Result<Self, ParseError>

Load a single markdown file from a path

Source

pub async fn from_dir(dir: &PathBuf) -> Result<Vec<(PathBuf, Self)>, Error>

Load all markdown files from a directory

Source

pub async fn from_nested_dirs( parent_dir: impl AsRef<Path>, filename: &str, ) -> Result<Vec<(PathBuf, Self)>, Error>

Load all markdown files from nested subdirectories, where each subdirectory contains a file with the specified filename.

Flat files in the parent directory are ignored. Only subdirectories containing the specified filename are processed.

§Example
// Load from:
//   skills/skill-1/SKILL.md
//   skills/skill-2/SKILL.md
//   skills/flat-file.md      -> ignored (not in a subdirectory)
let skills = MarkdownFile::from_nested_dirs(Path::new("skills"), "SKILL.md").await?;

Trait Implementations§

Source§

impl<T: Clone + DeserializeOwned> Clone for MarkdownFile<T>

Source§

fn clone(&self) -> MarkdownFile<T>

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<T: Debug + DeserializeOwned> Debug for MarkdownFile<T>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<T> Freeze for MarkdownFile<T>
where T: Freeze,

§

impl<T> RefUnwindSafe for MarkdownFile<T>
where T: RefUnwindSafe,

§

impl<T> Send for MarkdownFile<T>
where T: Send,

§

impl<T> Sync for MarkdownFile<T>
where T: Sync,

§

impl<T> Unpin for MarkdownFile<T>
where T: Unpin,

§

impl<T> UnsafeUnpin for MarkdownFile<T>
where T: UnsafeUnpin,

§

impl<T> UnwindSafe for MarkdownFile<T>
where T: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more