MarkdownWriter

src2md::writer

Struct MarkdownWriter 

Source 
pub struct MarkdownWriter<W: AsyncWriteExt + Unpin> { /* private fields */ }
Expand description

A writer that generates Markdown output with syntax-highlighted code blocks.

Uses dynamic backtick fencing to safely embed code that may contain triple backticks (like other Markdown files).

Implementations§

Source§

impl MarkdownWriter<File>

Source

pub fn new(writer: BufWriter<File>) -> Self

Creates a new MarkdownWriter wrapping the given buffered writer.

Source

pub async fn write_entry( &mut self, entry: &DirEntry, project_root: &Path, ) -> Result<()>

Writes a single file entry to the Markdown output.

  • Text files are wrapped in code blocks with appropriate language tags
  • Binary files are marked with “(binary file omitted)”
  • Dynamic fencing ensures safe embedding of files containing backticks
Source

pub async fn flush(&mut self) -> Result<()>

Flushes any buffered data to the underlying writer.

Auto Trait Implementations§

§

impl<W> Freeze for MarkdownWriter<W>
where W: Freeze,

§

impl<W> RefUnwindSafe for MarkdownWriter<W>
where W: RefUnwindSafe,

§

impl<W> Send for MarkdownWriter<W>
where W: Send,

§

impl<W> Sync for MarkdownWriter<W>
where W: Sync,

§

impl<W> Unpin for MarkdownWriter<W>

§

impl<W> UnwindSafe for MarkdownWriter<W>
where W: 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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. 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.