Trait struckdown::processors::Processor

pub trait Processor {
    pub fn apply<'data>(
        self: Box<Self>, 
        iter: Box<dyn Iterator<Item = AnnotatedEvent<'data>> + 'data>
    ) -> Box<dyn Iterator<Item = AnnotatedEvent<'data>> + 'data>;
    pub fn apply_ref<'data, 'options: 'data>(
        &'options self, 
        iter: Box<dyn Iterator<Item = AnnotatedEvent<'data>> + 'data>
    ) -> Box<dyn Iterator<Item = AnnotatedEvent<'data>> + 'data>;
}

Common trait for all stream processors.

Required methods

pub fn apply<'data>(
    self: Box<Self>,
    iter: Box<dyn Iterator<Item = AnnotatedEvent<'data>> + 'data>
) -> Box<dyn Iterator<Item = AnnotatedEvent<'data>> + 'data>

Applies the processor to an event stream.

This consumes the processor.

pub fn apply_ref<'data, 'options: 'data>(
    &'options self,
    iter: Box<dyn Iterator<Item = AnnotatedEvent<'data>> + 'data>
) -> Box<dyn Iterator<Item = AnnotatedEvent<'data>> + 'data>

Applies the processor to an event stream.

This attaches the processor by reference.

Loading content...

Implementors

impl Processor for BuiltinProcessor

pub fn apply<'data>(
    self: Box<Self>,
    iter: Box<dyn Iterator<Item = AnnotatedEvent<'data>> + 'data>
) -> Box<dyn Iterator<Item = AnnotatedEvent<'data>> + 'data>

pub fn apply_ref<'data, 'options: 'data>(
    &'options self,
    iter: Box<dyn Iterator<Item = AnnotatedEvent<'data>> + 'data>
) -> Box<dyn Iterator<Item = AnnotatedEvent<'data>> + 'data>

impl Processor for AutoAnchors

pub fn apply<'data>(
    self: Box<Self>,
    iter: Box<dyn Iterator<Item = AnnotatedEvent<'data>> + 'data>
) -> Box<dyn Iterator<Item = AnnotatedEvent<'data>> + 'data>

pub fn apply_ref<'data, 'options: 'data>(
    &'options self,
    iter: Box<dyn Iterator<Item = AnnotatedEvent<'data>> + 'data>
) -> Box<dyn Iterator<Item = AnnotatedEvent<'data>> + 'data>

impl Processor for External

pub fn apply<'data>(
    self: Box<Self>,
    iter: Box<dyn Iterator<Item = AnnotatedEvent<'data>> + 'data>
) -> Box<dyn Iterator<Item = AnnotatedEvent<'data>> + 'data>

pub fn apply_ref<'data, 'options: 'data>(
    &'options self,
    iter: Box<dyn Iterator<Item = AnnotatedEvent<'data>> + 'data>
) -> Box<dyn Iterator<Item = AnnotatedEvent<'data>> + 'data>

impl Processor for HtmlSanitizer

pub fn apply<'data>(
    self: Box<Self>,
    iter: Box<dyn Iterator<Item = AnnotatedEvent<'data>> + 'data>
) -> Box<dyn Iterator<Item = AnnotatedEvent<'data>> + 'data>

pub fn apply_ref<'data, 'options: 'data>(
    &'options self,
    iter: Box<dyn Iterator<Item = AnnotatedEvent<'data>> + 'data>
) -> Box<dyn Iterator<Item = AnnotatedEvent<'data>> + 'data>

impl Processor for Syntect

pub fn apply<'data>(
    self: Box<Self>,
    iter: Box<dyn Iterator<Item = AnnotatedEvent<'data>> + 'data>
) -> Box<dyn Iterator<Item = AnnotatedEvent<'data>> + 'data>

pub fn apply_ref<'data, 'options: 'data>(
    &'options self,
    iter: Box<dyn Iterator<Item = AnnotatedEvent<'data>> + 'data>
) -> Box<dyn Iterator<Item = AnnotatedEvent<'data>> + 'data>

impl Processor for TableOfContents

pub fn apply<'data>(
    self: Box<Self>,
    iter: Box<dyn Iterator<Item = AnnotatedEvent<'data>> + 'data>
) -> Box<dyn Iterator<Item = AnnotatedEvent<'data>> + 'data>

pub fn apply_ref<'data, 'options: 'data>(
    &'options self,
    iter: Box<dyn Iterator<Item = AnnotatedEvent<'data>> + 'data>
) -> Box<dyn Iterator<Item = AnnotatedEvent<'data>> + 'data>

Loading content...