Struct ScanOptions 

pub struct ScanOptions {
    pub code_rules: CodeRules,
    pub skip_html_comments: bool,
    pub self_links: bool,
}

What a body scan counts as a link. ScanOptions::default is what body_links_spanned and crate::body_links use.

Examples

use markdown_link::code::CodeRules;
use markdown_link::{ScanOptions, body_links_spanned_with};

let options = ScanOptions {
    code_rules: CodeRules::SkillExport,
    skip_html_comments: true,
    self_links: true,
};
let links = body_links_spanned_with("<!-- [[hidden]] --> [[#Intro]]", &options);
assert_eq!(links.len(), 1);
assert_eq!(links[0].target, "");
assert_eq!(links[0].heading.as_deref(), Some("Intro"));

Fields

code_rules: CodeRules

Which rules decide what is code. Links in code are not links.

skip_html_comments: bool

Skip links inside HTML comments, <!-- to --> or the end of the body. Off by default: a comment’s links are found.

self_links: bool

Read a wikilink with no target and a # fragment, [[#Heading]] or [[#^block]], as a link to the note it is written in, with an empty BodyLink::target. Off by default: such a link is dropped.

Trait Implementations

impl Clone for ScanOptions

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for ScanOptions

impl Debug for ScanOptions

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

Formats the value using the given formatter.

impl Default for ScanOptions

fn default() -> Self

Returns the “default value” for a type.

impl Eq for ScanOptions

impl PartialEq for ScanOptions

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for ScanOptions