Struct markdown_it::plugins::cmark::block::reference::ReferenceMap

pub struct ReferenceMap(_);

Storage for parsed references

if you have some external source for your link references, you can add them like this:

use markdown_it::parser::block::builtin::BlockParserRule;
use markdown_it::parser::core::{CoreRule, Root};
use markdown_it::plugins::cmark::block::reference::{ReferenceMap, DefaultReferenceMap, CustomReferenceMap};
use markdown_it::{MarkdownIt, Node};

let md = &mut MarkdownIt::new();
markdown_it::plugins::cmark::add(md);

#[derive(Debug, Default)]
struct RefMapOverride(DefaultReferenceMap);
impl CustomReferenceMap for RefMapOverride {
    fn get(&self, label: &str) -> Option<(&str, Option<&str>)> {
        // override a specific link
        if label == "rust" {
            return Some((
                "https://www.rust-lang.org/",
                Some("The Rust Language"),
            ));
        }

        self.0.get(label)
    }

    fn insert(&mut self, label: String, destination: String, title: Option<String>) -> bool {
        self.0.insert(label, destination, title)
    }
}

struct AddCustomReferences;
impl CoreRule for AddCustomReferences {
    fn run(root: &mut Node, _: &MarkdownIt) {
        let data = root.cast_mut::<Root>().unwrap();
        data.ext.insert(ReferenceMap::new(RefMapOverride::default()));
    }
}

md.add_rule::<AddCustomReferences>()
    .before::<BlockParserRule>();

let html = md.parse("[rust]").render();
assert_eq!(
    html.trim(),
    r#"<p><a href="https://www.rust-lang.org/" title="The Rust Language">rust</a></p>"#
);

You can also view all references that user created by adding the following rule:

use markdown_it::parser::core::{CoreRule, Root};
use markdown_it::plugins::cmark::block::reference::{ReferenceMap, DefaultReferenceMap};
use markdown_it::{MarkdownIt, Node};

let md = &mut MarkdownIt::new();
markdown_it::plugins::cmark::add(md);

let ast = md.parse("[hello]: world");
let root = ast.node_value.downcast_ref::<Root>().unwrap();
let refmap = root.ext.get::<ReferenceMap>()
    .map(|m| m.downcast_ref::<DefaultReferenceMap>().expect("expect references to be handled by default map"));

let mut labels = vec![];
if let Some(refmap) = refmap {
    for (label, _dest, _title) in refmap.iter() {
        labels.push(label);
    }
}

assert_eq!(labels, ["hello"]);

Implementations

impl ReferenceMap

pub fn new(custom_map: impl CustomReferenceMap + 'static) -> Self

Trait Implementations

impl Debug for ReferenceMap

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

Formats the value using the given formatter.

impl Default for ReferenceMap

fn default() -> Self

Returns the “default value” for a type.

impl Deref for ReferenceMapwhere Box<dyn CustomReferenceMap>: Deref,

type Target = <Box<dyn CustomReferenceMap + 'static, Global> as Deref>::Target

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for ReferenceMapwhere Box<dyn CustomReferenceMap>: DerefMut,

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl RootExt for ReferenceMap