Skip to main content

HighlightOptions

Struct HighlightOptions 

Source
pub struct HighlightOptions {
    pub highlighter: Option<Arc<Highlighter>>,
    pub theme: Option<Theme>,
    pub idiomatic: bool,
}
Available on crate feature highlight only.
Expand description

Syntax-highlighting configuration for the writers that colorize code blocks (the HTML family, LaTeX, and DOCX). The default leaves code blocks unhighlighted.

Fields§

§highlighter: Option<Arc<Highlighter>>

The tokenizer catalog. None leaves code blocks as a plain <pre><code>, with no color spans and no line-number scaffolding.

§theme: Option<Theme>

The active color theme, consulted by the writers that inline colors (LaTeX, DOCX) and to build the HTML family’s stylesheet. None when highlighting is off.

§idiomatic: bool

Present code blocks in the target format’s own listing construct rather than colorizing them. No tokenizer runs; a format that offers a dedicated listing environment (LaTeX’s lstlisting) uses it, while formats whose plain form already carries the language class (the HTML family, DOCX) render code exactly as they do with highlighting off. Ignored when a highlighter is set.

Trait Implementations§

Source§

impl Clone for HighlightOptions

Source§

fn clone(&self) -> HighlightOptions

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for HighlightOptions

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for HighlightOptions

Source§

fn default() -> HighlightOptions

Returns the “default value” for a type. 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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = !

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.