Skip to main content

SyntectHighlighter

Struct SyntectHighlighter 

Source
pub struct SyntectHighlighter;
Expand description

Highlights with syntect: its default grammars, its default themes, and upstream’s ansi_dark and ansi_light, which use the terminal’s own palette. This is the highlighter Syntax and Markdown use unless given another one.

Implementations§

Source§

impl SyntectHighlighter

Source

pub fn new() -> Self

Source

pub fn shared() -> Arc<dyn CodeHighlighter> ⓘ

The shared instance every Syntax uses by default.

Trait Implementations§

Source§

impl Clone for SyntectHighlighter

Source§

fn clone(&self) -> Self

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 CodeHighlighter for SyntectHighlighter

Source§

fn token_style(&self, theme: &str, token: &str) -> Option<Style>

Upstream’s ANSI_DARK/ANSI_LIGHT entry for the token; for a syntect theme, its foreground (Text) or its comment scope style.

Source§

fn highlight( &self, code: &str, language: Option<&str>, theme: &str, ) -> Result<HighlightedCode, HighlightError>

Highlight code. language is a name or file extension ("rust", "rs"); None means plain text. theme is one of themes.
Source§

fn default_theme(&self) -> &str

The theme used when none is chosen.
Source§

fn themes(&self) -> Vec<String>

Every theme name highlight accepts.
Source§

fn languages(&self) -> Vec<String>

Language names this highlighter knows, for help text and completion.
Source§

fn language_for_path(&self, path: &Path) -> Option<String>

The language for a file path, if the highlighter recognises it.
Source§

impl Copy for SyntectHighlighter

Source§

impl Debug for SyntectHighlighter

Source§

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

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

impl Default for SyntectHighlighter

Source§

fn default() -> Self

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, !>

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.