mdq 0.10.0

Select and render specific elements in a Markdown document
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72

use crate::md_elem::{MdContext, MdElem};
use crate::output::{write_md, MdWriterOptions};
use crate::util::output::{Output, SimpleWrite};
use std::{fmt, io};

/// A struct for writing [MdElem]s as Markdown (as per `--output markdown`).
#[derive(Copy, Clone, Default, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct MdWriter {
    options: MdWriterOptions,
}

impl MdWriter {
    /// Creates a new [MdWriter] with the given options.
    pub fn with_options(options: MdWriterOptions) -> Self {
        Self { options }
    }

    /// Writes the given nodes to the given writer.
    pub fn write<'md, W>(&self, ctx: &'md MdContext, nodes: &'md [MdElem], out: &mut W)
    where
        W: fmt::Write,
    {
        write_md(
            self.options,
            &mut Output::new(IoAdapter(out), self.options.text_width),
            ctx,
            nodes,
        )
    }
}

/// Adapter to convert between I/O types.
///
/// To use, wrap the source type in the `IoAdapter`, and use that adapter as the target type. For example, to convert
/// a [`std::io::Write`] into a [`std::fmt::Write`]:
///
/// ```
/// use mdq::output::IoAdapter;
///
/// fn example(input: impl std::io::Write) -> impl std::fmt::Write {
///     IoAdapter(input)
/// }
/// ```
///
/// [`std::io::Write`]: io::Write
/// [`std::fmt::Write`]: fmt::Write
#[derive(Copy, Clone, Default, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct IoAdapter<W>(pub W);

impl<W> From<W> for IoAdapter<W> {
    fn from(value: W) -> Self {
        Self(value)
    }
}

impl<W: fmt::Write> SimpleWrite for IoAdapter<W> {
    fn write_char(&mut self, ch: char) -> io::Result<()> {
        self.0
            .write_char(ch)
            .map_err(|err| io::Error::other(format!("while writing char: {err}")))
    }

    fn flush(&mut self) -> io::Result<()> {
        Ok(())
    }
}

impl<W: io::Write> fmt::Write for IoAdapter<W> {
    fn write_str(&mut self, s: &str) -> fmt::Result {
        self.0.write_all(s.as_bytes()).map_err(|_| fmt::Error)
    }
}