Struct SyntaxEditor

pub struct SyntaxEditor<'syntax_system, 'buffer> { /* private fields */ }

A wrapper of Editor with syntax highlighting provided by SyntaxSystem

Implementations

impl<'syntax_system, 'buffer> SyntaxEditor<'syntax_system, 'buffer>

pub fn new( buffer: impl Into<BufferRef<'buffer>>, syntax_system: &'syntax_system SyntaxSystem, theme_name: &str, ) -> Option<Self>

Create a new SyntaxEditor with the provided [Buffer], SyntaxSystem, and theme name.

A good default theme name is “base16-eighties.dark”.

Returns None if theme not found

pub fn update_theme(&mut self, theme_name: &str) -> bool

Modifies the theme of the SyntaxEditor, returning false if the theme is missing

pub fn load_text<P: AsRef<Path>>( &mut self, font_system: &mut FontSystem, path: P, attrs: Attrs<'_>, ) -> Result<()>

Load text from a file, and also set syntax to the best option

Errors

Returns an io::Error if reading the file fails

pub fn syntax_by_extension(&mut self, extension: &str)

Set syntax highlighting by file extension

pub fn background_color(&self) -> Color

Get the default background color

pub fn foreground_color(&self) -> Color

Get the default foreground (text) color

pub fn cursor_color(&self) -> Color

Get the default cursor color

pub fn selection_color(&self) -> Color

Get the default selection color

pub fn theme(&self) -> &SyntaxTheme

Get the current syntect theme

pub fn draw<F>( &self, font_system: &mut FontSystem, cache: &mut SwashCache, f: F, )

where F: FnMut(i32, i32, u32, u32, Color),

Draw the editor

Trait Implementations

impl<'syntax_system, 'buffer> Debug for SyntaxEditor<'syntax_system, 'buffer>

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

Formats the value using the given formatter.

impl<'buffer> Edit<'buffer> for SyntaxEditor<'_, 'buffer>

fn buffer_ref(&self) -> &BufferRef<'buffer>

Get the internal BufferRef

fn buffer_ref_mut(&mut self) -> &mut BufferRef<'buffer>

Get the internal BufferRef

fn cursor(&self) -> Cursor

Get the current cursor

fn set_cursor(&mut self, cursor: Cursor)

Set the current cursor

fn selection(&self) -> Selection

Get the current selection position

fn set_selection(&mut self, selection: Selection)

Set the current selection position

fn auto_indent(&self) -> bool

Get the current automatic indentation setting

fn set_auto_indent(&mut self, auto_indent: bool)

Enable or disable automatic indentation

fn tab_width(&self) -> u16

Get the current tab width

fn set_tab_width(&mut self, font_system: &mut FontSystem, tab_width: u16)

Set the current tab width. A tab_width of 0 is not allowed, and will be ignored

fn shape_as_needed(&mut self, font_system: &mut FontSystem, prune: bool)

Shape lines until scroll, after adjusting scroll if the cursor moved

fn delete_range(&mut self, start: Cursor, end: Cursor)

Delete text starting at start Cursor and ending at end Cursor

fn insert_at( &mut self, cursor: Cursor, data: &str, attrs_list: Option<AttrsList>, ) -> Cursor

Insert text at specified cursor with specified attrs_list

fn copy_selection(&self) -> Option<String>

Copy selection

fn delete_selection(&mut self) -> bool

Delete selection, adjusting cursor and returning true if there was a selection

fn apply_change(&mut self, change: &Change) -> bool

Apply a change

fn start_change(&mut self)

Start collecting change

fn finish_change(&mut self) -> Option<Change>

Get completed change

fn action(&mut self, font_system: &mut FontSystem, action: Action)

Perform an Action on the editor

fn cursor_position(&self) -> Option<(i32, i32)>

Get X and Y position of the top left corner of the cursor

fn borrow_with<'font_system>( &'font_system mut self, font_system: &'font_system mut FontSystem, ) -> BorrowedWithFontSystem<'font_system, Self>

where Self: Sized,

Mutably borrows self together with an FontSystem for more convenient methods

fn with_buffer<F: FnOnce(&Buffer) -> T, T>(&self, f: F) -> T

Get the internal Buffer

fn with_buffer_mut<F: FnOnce(&mut Buffer) -> T, T>(&mut self, f: F) -> T

Get the internal Buffer, mutably

fn redraw(&self) -> bool

Get the Buffer redraw flag

fn set_redraw(&mut self, redraw: bool)

Set the Buffer redraw flag

fn selection_bounds(&self) -> Option<(Cursor, Cursor)>

Get the bounds of the current selection

fn insert_string(&mut self, data: &str, attrs_list: Option<AttrsList>)

Insert a string at the current cursor or replacing the current selection with the given attributes, or with the previous character’s attributes if None is given.