Skip to main content

SyntaxHighlighter

ratatui_toolkit::widgets

Struct SyntaxHighlighter 

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

Syntax highlighting for code blocks using syntect.

This module provides syntax highlighting functionality for code blocks in markdown documents using the syntect library. Highlighter for code blocks using syntect.

Implementations§

Source§

impl SyntaxHighlighter

Default constructor for SyntaxHighlighter.

Source

pub fn new() -> SyntaxHighlighter

Available on crate feature markdown-preview only.

Create a new syntax highlighter with default dark theme.

Source§

impl SyntaxHighlighter

Custom theme constructor for SyntaxHighlighter.

Source

pub fn with_custom_theme(theme: Theme) -> SyntaxHighlighter

Available on crate feature markdown-preview only.

Create a new syntax highlighter with custom theme.

Source§

impl SyntaxHighlighter

Dark theme constructor for SyntaxHighlighter.

Source

pub fn with_dark_theme() -> SyntaxHighlighter

Available on crate feature markdown-preview only.

Create a new syntax highlighter with dark theme.

Source§

impl SyntaxHighlighter

Light theme constructor for SyntaxHighlighter.

Source

pub fn with_light_theme() -> SyntaxHighlighter

Available on crate feature markdown-preview only.

Create a new syntax highlighter with GitHub Light theme.

Source§

impl SyntaxHighlighter

Named theme constructor for SyntaxHighlighter.

Source

pub fn with_named_theme(theme_name: &str) -> SyntaxHighlighter

Available on crate feature markdown-preview only.

Create a new syntax highlighter with a specific theme name.

§Arguments
  • theme_name - Name of the theme (e.g., “base16-ocean.dark”, “github-dark”, “github-light”)
Source§

impl SyntaxHighlighter

This impl block contains no items.

Find syntax method for SyntaxHighlighter.

Source§

impl SyntaxHighlighter

Source

pub fn highlight(&self, content: &str, language: &str) -> Option<Text<'static>>

Available on crate feature markdown-preview only.

Highlight code content for a given language.

§Arguments
  • content - The code content to highlight
  • language - The language identifier (e.g., “rust”, “python”, “javascript”)
§Returns

Syntax highlighted text, or None if language is not recognized

Source§

impl SyntaxHighlighter

Highlight with line numbers method for SyntaxHighlighter.

Source

pub fn highlight_with_line_numbers( &self, content: &str, language: &str, start_line: usize, ) -> Option<Text<'static>>

Available on crate feature markdown-preview only.

Highlight multiple lines of code with line numbers.

§Arguments
  • content - The code content to highlight
  • language - The language identifier
  • start_line - Starting line number for display
§Returns

Syntax highlighted text with line numbers

Source§

impl SyntaxHighlighter

Set dark theme method for SyntaxHighlighter.

Source

pub fn set_dark_theme(&mut self)

Available on crate feature markdown-preview only.

Set the theme to dark mode.

Source§

impl SyntaxHighlighter

Set light theme method for SyntaxHighlighter.

Source

pub fn set_light_theme(&mut self)

Available on crate feature markdown-preview only.

Set the theme to light mode (GitHub Light).

Source§

impl SyntaxHighlighter

Theme variant getter method for SyntaxHighlighter.

Source

pub fn theme_variant(&self) -> SyntaxThemeVariant

Available on crate feature markdown-preview only.

Get the current theme variant.

Source§

impl SyntaxHighlighter

Toggle theme method for SyntaxHighlighter.

Source

pub fn toggle_theme(&mut self)

Available on crate feature markdown-preview only.

Switch between light and dark themes.

Trait Implementations§

Source§

impl Default for SyntaxHighlighter

Available on crate feature markdown-preview only.

Default trait implementation for SyntaxHighlighter.

Source§

fn default() -> SyntaxHighlighter

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more