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

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.

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.

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.