Enum MarkdownSelector 

#[repr(u8)]
pub enum MarkdownSelector {
    Heading {
        level: HeadingLevel,
        content: String,
    },
    Marker {
        name: MarkerNameBuf,
        blocks: Vec<MarkdownBlock>,
    },
}

A selector naming one region of an existing Markdown document to manage.

Variants

Heading

Selects the unique heading of a level and replaces its text.

Fields

level: HeadingLevel

The level of the one heading to match.

content: String

The replacement heading text.

Marker

Selects a named marker region.

Fields

name: MarkerNameBuf

The marker’s name.

blocks: Vec<MarkdownBlock>

The replacement blocks.

Implementations

impl MarkdownSelector

fn validate(&self) -> Result<(), MarkdownError>

Check the selector on its own.

Errors

Returns an error for heading content that spans lines.

fn check_shadowing(&self, others: &[Self]) -> Result<(), MarkdownError>

Fail if this marker renders a heading that one of others selects.

pub(super) fn validate_all(selectors: &[Self]) -> Result<(), MarkdownError>

Check the selectors without reading any source.

Errors

Returns an error for invalid selectors and marker blocks that shadow a heading selector.

pub(super) fn reconcile_all( source: &Source<'_>, selectors: &[Self], ) -> Result<Vec<u8>, DocumentError>

Reconcile selected Markdown regions while preserving all source outside them. The output uses the line ending of source.

Errors

Returns an error for malformed Markdown, invalid selectors, marker blocks that shadow a heading selector, or overlapping selections.

fn resolve(&self, targets: &Targets<'_>) -> Result<Edit, DocumentError>

The source range this selector replaces and its rendered replacement.

Trait Implementations

impl Clone for MarkdownSelector

fn clone(&self) -> MarkdownSelector

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MarkdownSelector

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

Formats the value using the given formatter.

impl Eq for MarkdownSelector

impl<'ʄ> Facet<'ʄ> for MarkdownSelector

const SHAPE: &'static Shape

The shape of this type, including: whether it’s a Struct, an Enum, something else?

impl PartialEq for MarkdownSelector

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for MarkdownSelector