Skip to main content

MarkdownIngester

Struct MarkdownIngester 

Source
pub struct MarkdownIngester { /* private fields */ }
Expand description

Markdown file ingester that parses and chunks markdown documents.

The ingester handles:

  • YAML front-matter extraction
  • Content chunking by headings
  • Code block preservation with language tags
  • Recursive directory traversal

Implementations§

Source§

impl MarkdownIngester

Source

pub fn new() -> Self

Create a new markdown ingester with default configuration.

Source

pub fn with_config(config: IngesterConfig) -> Self

Create a new markdown ingester with custom configuration.

Source

pub async fn ingest_file(&self, path: &Path) -> Result<MarkdownDocument>

Ingest a single markdown file.

This method reads the file, extracts front-matter, parses the markdown, and returns a structured document with chunks.

§Arguments
  • path - Path to the markdown file
§Returns

A MarkdownDocument containing the parsed content and metadata

§Errors

Returns an error if the file cannot be read or is not valid UTF-8

Source

pub async fn ingest_directory( &self, dir: &Path, recursive: bool, ) -> Result<Vec<MarkdownDocument>>

Ingest all markdown files in a directory.

§Arguments
  • dir - Path to the directory
  • recursive - Whether to recursively traverse subdirectories
§Returns

A vector of MarkdownDocument for each markdown file found

§Errors

Returns an error if the directory cannot be read

Source

pub fn extract_frontmatter( content: &str, ) -> (Option<HashMap<String, String>>, &str)

Extract YAML front-matter from markdown content.

Front-matter is expected to be at the very beginning of the file, delimited by --- lines. For example:

---
title: My Document
author: John Doe
date: 2024-01-15
---

# Document content starts here
§Arguments
  • content - The full markdown file content
§Returns

A tuple of (optional metadata HashMap, remaining content after front-matter)

Trait Implementations§

Source§

impl Clone for MarkdownIngester

Source§

fn clone(&self) -> MarkdownIngester

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 Debug for MarkdownIngester

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for MarkdownIngester

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

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> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

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

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
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> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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