Struct rucline::Buffer

pub struct Buffer { /* fields omitted */ }

A String that also keeps track of its cursor position.

When presenting the context of the line reader to an action or a completion, the Buffer is used as a read-only view into the line reader's buffer state.

Basic example:

use rucline::actions::Direction::Backward;
use rucline::actions::Range::Word;
use rucline::actions::Scope::WholeWord;
use rucline::Buffer;

let mut buffer: Buffer = "my new buffer".into();
assert_eq!(buffer.as_str(), "my new buffer");
assert_eq!(buffer.cursor(), "my new buffer".len());

buffer.move_cursor(Word, Backward);
assert_eq!(buffer.as_str(), "my new buffer");
assert_eq!(buffer.cursor(), "my new ".len());

buffer.delete(WholeWord);
assert_eq!(buffer.as_str(), "my new ");
assert_eq!(buffer.cursor(), "my new ".len());

Implementations

impl Buffer

#[must_use]pub fn new() -> Self

Creates an empty buffer.

pub fn new_with_cursor<S: AsRef<str>>(
    string: S,
    cursor: usize
) -> Result<Self, InvalidIndex>

Creates a new Buffer from string with a given cursor position.

This is a short-hand for:

let mut buffer = Buffer::from(string);
buffer.set_cursor(cursor);

Errors

• If the curosr position does not fall into a character boundary.

#[must_use]pub fn as_str(&self) -> &str

Returns the current buffer string.

#[must_use]pub fn cursor(&self) -> usize

Returns the current position of the cursor.

pub fn set_cursor(&mut self, cursor: usize) -> Result<(), InvalidIndex>

Sets the cursor position in the buffer.

Errors

• If the curosr position does not fall into a character boundary.

pub fn go_to_end(&mut self)

Puts the cursor at the end of the buffer.

This is short-hand for move_cursor(Range::Line, Direction::Forward)

pub fn clear(&mut self)

Clears the buffer and sets the cursor back to zero.

pub fn write(&mut self, c: char)

Inserts a single character to the buffer at the cursor position and increments the cursor by one.

Arguments

• c - The character to insert.

pub fn write_str(&mut self, string: &str)

Inserts a string to the buffer at the cursor position and increments the cursor by the length of string.

Arguments

• string - The string to insert.

pub fn write_range(&mut self, string: &str, range: Range)

Inserts a range of a string to the buffer at the cursor position and increments the cursor by the length of the range.

Arguments

• string - The string to insert.
• range - The range from string to insert.

pub fn delete(&mut self, scope: Scope)

Deletes the given scope from this buffer and updates the cursor accordingly.

Arguments

• scope - The scope of the deletion.

pub fn move_cursor(&mut self, range: Range, direction: Direction)

Moves the cursor by range.

Arguments

• range - The range of the movement.
• direction - The direction of the movement.

Trait Implementations

impl Clone for Buffer

fn clone(&self) -> Buffer

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Buffer

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

Formats the value using the given formatter.

impl Default for Buffer

fn default() -> Self

Returns the "default value" for a type.

impl Deref for Buffer

type Target = str

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Display for Buffer

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

Formats the value using the given formatter.

impl Eq for Buffer

impl<S> From<S> for Buffer where
    S: AsRef<str>, 

fn from(string: S) -> Self

Performs the conversion.

impl PartialEq<Buffer> for Buffer

fn eq(&self, other: &Buffer) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Buffer) -> bool

This method tests for !=.

impl StructuralEq for Buffer

impl StructuralPartialEq for Buffer