Struct Syntax 

pub struct Syntax {
    pub code: String,
    pub language: String,
    pub theme: String,
    pub start_line: usize,
    pub line_numbers: bool,
    pub highlight: bool,
    pub background_color: Option<Color>,
    pub tab_size: usize,
    pub line_styles: HashMap<usize, Style>,
}

A syntax-highlighted source code renderable.

Fields

code: String

The source code.

language: String

The language name (e.g. “rust”, “python”, “javascript”).

theme: String

Optional theme name.

start_line: usize

Starting line number (for line numbers).

line_numbers: bool

If true, show line numbers.

highlight: bool

If true, highlight the code.

background_color: Option<Color>

Optional background color.

tab_size: usize

Tab size.

line_styles: HashMap<usize, Style>

Per-line styles for line range highlighting (used by stylize_range).

Implementations

impl Syntax

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

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

pub fn theme(self, theme: impl Into<String>) -> Self

Builder: set the syntect theme name (e.g. "base16-ocean.dark", "monokai").

pub fn line_numbers(self) -> Self

Builder: enable line numbers in the rendered output.

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

Builder: set the starting line number for display (default 1).

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

Builder: set a background color for the code block.

pub fn from_path( path: impl AsRef<Path>, line_numbers: bool, theme: Option<&str>, ) -> Result<Self>

Create a Syntax from a file path, auto-detecting the language from the extension.

Reads the file contents and infers the programming language from the file extension. Optionally enables line numbers and sets a theme.

Errors

Returns an IO error if the file cannot be read.

Example

use rusty_rich::Syntax;

let syntax = Syntax::from_path("main.rs", true, Some("monokai")).unwrap();

pub fn guess_lexer(path: impl AsRef<Path>) -> Option<String>

Guess the syntax lexer name from a file path’s extension.

Delegates to guess_lexer_for_filename by extracting the file stem and extension from the provided path.

pub fn stylize_range( self, start_line: usize, end_line: usize, style: Style, ) -> Self

Apply a background style to a range of lines (for highlighting).

Returns a new Syntax with the style applied to the specified lines (1-based, inclusive). This is useful for highlighting a specific range of lines, e.g. the current line in a debugger.

Example

use rusty_rich::{Syntax, Style, Color};

let syntax = Syntax::new("line1\nline2", "text")
    .stylize_range(1, 1, Style::new().bgcolor(Color::from_rgb(255, 255, 200)));

pub fn get_theme(&self) -> &str

Get the current theme name.

pub fn default_lexer() -> &'static str

Return the default lexer name ("text").

Trait Implementations

impl Clone for Syntax

fn clone(&self) -> Syntax

Returns a duplicate of the value.

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

Performs copy-assignment from source.

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, _options: &ConsoleOptions) -> RenderResult

Render this object into a RenderResult using the provided options.

fn measure(&self, _options: &ConsoleOptions) -> Option<Measurement>

Optional width-measurement hook (equivalent to __rich_measure__). Override to provide min/max width constraints for layout.