Struct Syntax 

pub struct Syntax { /* private fields */ }

Implementations

impl Syntax

pub fn new(code: impl Into<String>, lexer: impl Into<String>) -> Self

Create a new Syntax object for the given code and language.

Arguments

• code - The source code to highlight.
• lexer - The language name (e.g., “rust”, “python”, “javascript”).

Example

use rich_rs::Syntax;

let syntax = Syntax::new("print('hello')", "python");

pub fn from_path(path: impl AsRef<Path>) -> Result<Self>

Create a Syntax object from a file path.

The language is auto-detected from the file extension.

Arguments

• path - Path to the source file.

Returns

Ok(Syntax) if the file was read successfully, Err otherwise.

Example

let syntax = Syntax::from_path("src/main.rs")?;

pub fn guess_lexer(path: impl AsRef<Path>, code: Option<&str>) -> String

Guess the language/lexer for a file path.

Arguments

• path - Path to examine.
• code - Optional code content for better detection.

Returns

The best-guess language name.

pub fn get_theme(name: &str) -> Box<dyn SyntaxTheme>

Get a theme by name.

Arguments

• name - Theme name (e.g., “monokai”, “dracula”, “github-dark”).

Returns

A boxed SyntaxTheme. Falls back to Monokai if the theme is not found.

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

List available theme names.

pub fn available_languages() -> Vec<String>

List available language/lexer names.

pub fn with_theme(self, theme: impl AsRef<str>) -> Self

Set the theme by name.

This overrides the Console’s theme for this renderable.

pub fn with_custom_theme(self, theme: Box<dyn SyntaxTheme>) -> Self

Set a custom theme.

This overrides the Console’s theme for this renderable.

pub fn with_dedent(self, dedent: bool) -> Self

Enable or disable code dedenting.

pub fn with_line_numbers(self, line_numbers: bool) -> Self

Enable or disable line numbers.

pub fn with_start_line(self, start_line: usize) -> Self

Set the starting line number.

pub fn with_line_range(self, start: Option<usize>, end: Option<usize>) -> Self

Set the line range to display.

Arguments

• start - Optional start line (1-based, inclusive).
• end - Optional end line (1-based, inclusive).

pub fn with_highlight_lines( self, lines: impl IntoIterator<Item = usize>, ) -> Self

Set lines to highlight.

pub fn with_code_width(self, width: usize) -> Self

Set a fixed code width.

pub fn with_tab_size(self, tab_size: usize) -> Self

Set the tab size.

pub fn with_word_wrap(self, word_wrap: bool) -> Self

Enable or disable word wrapping.

NOTE: Not yet implemented - option is stored for future use.

pub fn with_background_color(self, color: Color) -> Self

Set a background color override.

pub fn with_indent_guides(self, indent_guides: bool) -> Self

Enable or disable indent guides.

NOTE: Not yet implemented - option is stored for future use.

pub fn with_padding(self, padding: impl Into<PaddingDimensions>) -> Self

Set padding around the syntax block.

pub fn stylize_range( &mut self, style: Style, start: (usize, usize), end: (usize, usize), )

Add a custom style range to apply on top of syntax highlighting.

Positions are (line, column) where line is 1-based and column is 0-based.

Arguments

• style - Style to apply to the range.
• start - Start position as (line, column).
• end - End position as (line, column).

pub fn with_highlight_range( self, style: Style, start: (usize, usize), end: (usize, usize), ) -> Self

Builder method to add a highlight range.

Positions are (line, column) where line is 1-based and column is 0-based.

pub fn code(&self) -> &str

Get the source code.

pub fn lexer(&self) -> &str

Get the lexer/language name.

pub fn line_numbers(&self) -> bool

Check if line numbers are enabled.

pub fn tab_size(&self) -> usize

Get the tab size.

pub fn highlight(&self) -> Text

Highlight the code and return a Text object.

This converts syntect-highlighted code into a rich-rs Text object with styled spans.

Trait Implementations

impl Debug for Syntax

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

Formats the value using the given formatter.

impl Renderable for Syntax

fn render( &self, console: &Console<Stdout>, options: &ConsoleOptions, ) -> Segments

Render this object to a sequence of segments.

fn measure( &self, _console: &Console<Stdout>, options: &ConsoleOptions, ) -> Measurement

Measure the minimum and maximum width requirements.