pub struct SyntaxHighlighter { /* private fields */ }Expand description
A syntax highlighter that supports incremental parsing, multiline text, and caching of highlight results.
Implementations§
Source§impl SyntaxHighlighter
impl SyntaxHighlighter
pub fn is_empty(&self) -> bool
Sourcepub fn update(&mut self, edit: Option<InputEdit>, text: &Rope)
pub fn update(&mut self, edit: Option<InputEdit>, text: &Rope)
Highlight the given text, returning a map from byte ranges to highlight captures.
Uses incremental parsing by edit to efficiently update the highlighter’s state.
Sourcepub fn styles(
&self,
range: &Range<usize>,
theme: &HighlightTheme,
) -> Vec<(Range<usize>, HighlightStyle)>
pub fn styles( &self, range: &Range<usize>, theme: &HighlightTheme, ) -> Vec<(Range<usize>, HighlightStyle)>
Returns the syntax highlight styles for a range of text.
The argument range is the range of bytes in the text to highlight.
Returns a vector of tuples where each tuple contains:
- A byte range relative to the text
- The corresponding highlight style for that range
§Example
use gpui_component::highlighter::{HighlightTheme, SyntaxHighlighter};
use ropey::Rope;
let code = "fn main() {\n println!(\"Hello\");\n}";
let rope = Rope::from_str(code);
let mut highlighter = SyntaxHighlighter::new("rust");
highlighter.update(None, &rope);
let theme = HighlightTheme::default_dark();
let range = 0..code.len();
let styles = highlighter.styles(&range, &theme);Auto Trait Implementations§
impl Freeze for SyntaxHighlighter
impl RefUnwindSafe for SyntaxHighlighter
impl Send for SyntaxHighlighter
impl Sync for SyntaxHighlighter
impl Unpin for SyntaxHighlighter
impl UnsafeUnpin for SyntaxHighlighter
impl UnwindSafe for SyntaxHighlighter
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
Source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Convert
Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can
then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.Source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Convert
Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be
further downcast into Rc<ConcreteType> where ConcreteType implements Trait.Source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
Convert
&Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &Any’s vtable from &Trait’s.Source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
Convert
&mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &mut Any’s vtable from &mut Trait’s.Source§impl<T> DowncastSync for T
impl<T> DowncastSync for T
impl<T> ErasedDestructor for Twhere
T: 'static,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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