Struct struckdown::processors::Syntect

pub struct Syntect {
    pub theme: Option<String>,
    pub theme_path: Option<PathBuf>,
}

Implements syntax highlighting via syntect.

When applied this wraps the stream in a SyntectIter.

Fields

theme: Option<String>

The name of the theme to use. If both this and theme_path is not set then a default theme is loaded. If theme_path is set then the theme in the theme_path folder is used.

theme_path: Option<PathBuf>

When theme is not set, then the path to the .tmTheme file to load otherwise the folder to a collection of theme files.

Trait Implementations

impl Clone for Syntect

pub fn clone(&self) -> Syntect

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Syntect

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

Formats the value using the given formatter.

impl Default for Syntect

pub fn default() -> Syntect

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for Syntect where
    Syntect: Default, 

pub fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

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>

Applies the processor to an event stream.

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.

impl Serialize for Syntect

pub fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.