Skip to main content

SyntaxHighlighter

Struct SyntaxHighlighter 

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

Tree-sitter-based syntax highlighter for TUI code blocks.

Supports Rust, Python, JavaScript, JSON, TOML, and Bash out of the box. Language aliases ("rs""rust", "sh""bash", etc.) are resolved transparently.

Construct via the SYNTAX_HIGHLIGHTER static for process-level sharing, or call the private new method directly in tests.

§Supported languages

IdentifierAliases
rustrs
pythonpy
javascriptjs
bashsh, shell
json
toml

§Examples

use zeph_tui::highlight::SYNTAX_HIGHLIGHTER;
use zeph_tui::theme::SyntaxTheme;

let theme = SyntaxTheme::default();

// Known language → styled spans
let spans = SYNTAX_HIGHLIGHTER.highlight("rust", "fn main() {}", &theme);
assert!(spans.is_some());

// Alias works the same way
let spans = SYNTAX_HIGHLIGHTER.highlight("rs", "let x = 1;", &theme);
assert!(spans.is_some());

// Unknown language → None
assert!(SYNTAX_HIGHLIGHTER.highlight("brainfuck", "+++", &theme).is_none());

Implementations§

Source§

impl SyntaxHighlighter

Source

pub fn highlight( &self, lang: &str, code: &str, theme: &SyntaxTheme, ) -> Option<Vec<Span<'static>>>

Highlight code for the given lang using theme.

Returns None if the language is unsupported or if tree-sitter fails to parse the input. The returned spans concatenate to the original source text unchanged.

§Arguments
  • lang — language identifier or alias (case-insensitive).
  • code — source code to highlight.
  • theme — style mapping for each token class.
§Examples
use zeph_tui::highlight::SYNTAX_HIGHLIGHTER;
use zeph_tui::theme::SyntaxTheme;

let theme = SyntaxTheme::default();
let spans = SYNTAX_HIGHLIGHTER.highlight("rust", "let x = 42;", &theme).unwrap();
let text: String = spans.iter().map(|s| s.content.as_ref()).collect();
assert_eq!(text, "let x = 42;");

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

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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