Struct StringEditor

pub struct StringEditor { /* private fields */ }

A StringEditor instance wraps a String and provides a way to edit it using a variety of commands. It also keeps track of the cursor position, which can be used for rendering.

Example

use string_cmd::StringEditor;

let mut editor = StringEditor::new();

// Insert text
editor.execute(Command::Insert('H'));
editor.execute(Command::Insert('e'));
editor.execute(Command::Insert('l'));
editor.execute(Command::Insert('l'));
editor.execute(Command::Insert('o'));

// Get the current text
let text = editor.get_text(); // "Hello"

// Get the cursor position
let cursor = editor.cursor_pos(); // 5

In most cases, you’ll want to use the StringEditor in conjunction with a terminal event loop. If you’re using crossterm and want to use the default keybindings, check out the events module (requires the crossterm feature).

Implementations

impl StringEditor

pub fn new() -> Self

Create a new StringEditor with an empty string.

Examples found in repository

examples/demo.rs (line 11)

fn main() -> std::io::Result<()> {
    let mut editor = StringEditor::new();
    let mut stdout = std::io::stdout();

    println!("Enter text below:");
    enable_raw_mode()?;

    let input = loop {
        if event::poll(Duration::from_millis(10))? {
            let event = event::read()?;
            if let event::Event::Key(key) = &event {
                let ctrl = key.modifiers.contains(event::KeyModifiers::CONTROL);

                match key.code {
                    KeyCode::Esc => break None,
                    KeyCode::Char('q') if ctrl => break None,
                    KeyCode::Enter => break Some(editor.get_text()),
                    _ => {}
                }
            }

            if let Some(command) = event_to_command(&event) {
                editor.execute(command);
            }
        }

        execute!(
            stdout,
            cursor::MoveToColumn(0),
            terminal::Clear(terminal::ClearType::CurrentLine)
        )?;
        print!("{}", editor.get_text());
        execute!(stdout, cursor::MoveToColumn(editor.cursor_pos() as u16))?;
    };

    disable_raw_mode()?;
    println!("\nGot input: {:?}", input);

    Ok(())
}

pub fn with_string(text: &str) -> Self

Create a new StringEditor with a given string. Sets the cursor position to just after the end of the string.

pub fn get_text(&self) -> &str

Get the current text of the editor.

Examples found in repository

examples/demo.rs (line 26)

fn main() -> std::io::Result<()> {
    let mut editor = StringEditor::new();
    let mut stdout = std::io::stdout();

    println!("Enter text below:");
    enable_raw_mode()?;

    let input = loop {
        if event::poll(Duration::from_millis(10))? {
            let event = event::read()?;
            if let event::Event::Key(key) = &event {
                let ctrl = key.modifiers.contains(event::KeyModifiers::CONTROL);

                match key.code {
                    KeyCode::Esc => break None,
                    KeyCode::Char('q') if ctrl => break None,
                    KeyCode::Enter => break Some(editor.get_text()),
                    _ => {}
                }
            }

            if let Some(command) = event_to_command(&event) {
                editor.execute(command);
            }
        }

        execute!(
            stdout,
            cursor::MoveToColumn(0),
            terminal::Clear(terminal::ClearType::CurrentLine)
        )?;
        print!("{}", editor.get_text());
        execute!(stdout, cursor::MoveToColumn(editor.cursor_pos() as u16))?;
    };

    disable_raw_mode()?;
    println!("\nGot input: {:?}", input);

    Ok(())
}

pub fn cursor_pos(&self) -> usize

Get the current cursor position.

Examples found in repository

examples/demo.rs (line 42)

fn main() -> std::io::Result<()> {
    let mut editor = StringEditor::new();
    let mut stdout = std::io::stdout();

    println!("Enter text below:");
    enable_raw_mode()?;

    let input = loop {
        if event::poll(Duration::from_millis(10))? {
            let event = event::read()?;
            if let event::Event::Key(key) = &event {
                let ctrl = key.modifiers.contains(event::KeyModifiers::CONTROL);

                match key.code {
                    KeyCode::Esc => break None,
                    KeyCode::Char('q') if ctrl => break None,
                    KeyCode::Enter => break Some(editor.get_text()),
                    _ => {}
                }
            }

            if let Some(command) = event_to_command(&event) {
                editor.execute(command);
            }
        }

        execute!(
            stdout,
            cursor::MoveToColumn(0),
            terminal::Clear(terminal::ClearType::CurrentLine)
        )?;
        print!("{}", editor.get_text());
        execute!(stdout, cursor::MoveToColumn(editor.cursor_pos() as u16))?;
    };

    disable_raw_mode()?;
    println!("\nGot input: {:?}", input);

    Ok(())
}

impl StringEditor

pub fn execute(&mut self, command: Command)

Execute a command on the editor.

Examples found in repository

examples/demo.rs (line 32)

fn main() -> std::io::Result<()> {
    let mut editor = StringEditor::new();
    let mut stdout = std::io::stdout();

    println!("Enter text below:");
    enable_raw_mode()?;

    let input = loop {
        if event::poll(Duration::from_millis(10))? {
            let event = event::read()?;
            if let event::Event::Key(key) = &event {
                let ctrl = key.modifiers.contains(event::KeyModifiers::CONTROL);

                match key.code {
                    KeyCode::Esc => break None,
                    KeyCode::Char('q') if ctrl => break None,
                    KeyCode::Enter => break Some(editor.get_text()),
                    _ => {}
                }
            }

            if let Some(command) = event_to_command(&event) {
                editor.execute(command);
            }
        }

        execute!(
            stdout,
            cursor::MoveToColumn(0),
            terminal::Clear(terminal::ClearType::CurrentLine)
        )?;
        print!("{}", editor.get_text());
        execute!(stdout, cursor::MoveToColumn(editor.cursor_pos() as u16))?;
    };

    disable_raw_mode()?;
    println!("\nGot input: {:?}", input);

    Ok(())
}

Trait Implementations

impl Clone for StringEditor

fn clone(&self) -> StringEditor

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StringEditor

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

Formats the value using the given formatter.

impl Default for StringEditor

fn default() -> StringEditor

Returns the “default value” for a type.