Struct MDLinkFormatter

pub struct MDLinkFormatter;

Default link validator and formatter for markdown-it.

This validator can prohibit more than really needed to prevent XSS. It’s a tradeoff to keep code simple and to be secure by default.

If you need a different setup-override the validator method as you wish. Or replace it with a placeholder function and use external sanitizer.

Implementations

impl MDLinkFormatter

pub fn new() -> Self

Trait Implementations

impl Debug for MDLinkFormatter

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

Formats the value using the given formatter.

impl Default for MDLinkFormatter

fn default() -> MDLinkFormatter

Returns the “default value” for a type.

impl LinkFormatter for MDLinkFormatter

fn validate_link(&self, url: &str) -> Option<()>

Validate the link url, return Some(()) if it is allowed and None if it is a security risk.

fn normalize_link(&self, url: &str) -> String

Encode link url to a machine-readable format, which includes url-encoding, punycode, etc.

fn normalize_link_text(&self, url: &str) -> String

Decode link url to a human-readable format.