Skip to main content

SyntectAdapter

Struct SyntectAdapter 

Source
pub struct SyntectAdapter { /* private fields */ }
Expand description

A syntect-backed adapter for comrak’s rendering plugin system.

Performs syntax highlighting during HTML rendering using class-based output. The adapter does not emit <pre> / <code> itself — comrak’s renderer handles those tags via [SyntaxHighlighterAdapter::write_pre_tag] and [SyntaxHighlighterAdapter::write_code_tag].

Implementations§

Source§

impl SyntectAdapter

Source

pub fn new(theme: Option<&str>) -> Self

Creates a new adapter, optionally with a named theme.

The theme name is retained so callers can recover it via SyntectAdapter::theme_name and pass it to theme_css when generating a stylesheet for the rendered output. Falls back to DEFAULT_THEME when the requested theme is not in syntect’s built-in set.

Source

pub fn theme_name(&self) -> &str

Returns the resolved theme name (after fallback).

Source

pub fn available_themes() -> Vec<&'static str>

Returns the list of available theme names.

Trait Implementations§

Source§

impl SyntaxHighlighterAdapter for SyntectAdapter

Source§

fn write_highlighted( &self, output: &mut dyn Write, lang: Option<&str>, code: &str, ) -> Result

Generates a syntax highlighted HTML output. Read more
Source§

fn write_pre_tag( &self, output: &mut dyn Write, attributes: HashMap<&'static str, Cow<'_, str>>, ) -> Result

Generates the opening <pre> tag. Some syntax highlighter libraries might include their own <pre> tag possibly with some HTML attribute pre-filled. Read more
Source§

fn write_code_tag( &self, output: &mut dyn Write, attributes: HashMap<&'static str, Cow<'_, str>>, ) -> Result

Generates the opening <code> tag. Some syntax highlighter libraries might include their own <code> tag possibly with some HTML attribute pre-filled. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.