Struct TextLine

pub struct TextLine { /* private fields */ }

The text line represents editable text lines.

Implementations

impl TextLine

pub fn cursor_movement( movement: Direction, skip: bool, ) -> fn(&Self, &mut usize) -> bool

Returns the appropriate movement function based on parameters movement and skip.

Arguments

• movement - The direction of movement (Forward or Backward).
• skip - Whether to skip over whitespace characters.

Returns

A function pointer to the appropriate movement function.

Examples

use text_editing::{TextLine, Direction};

let line = TextLine::from_string("Hello, world!".into());
let mut text_cursor = 7;
let movement_fn = TextLine::cursor_movement(Direction::Forward, false);
movement_fn(&line, &mut text_cursor);
assert_eq!(text_cursor, 8);

pub fn forward(&self, text_cursor: &mut usize) -> bool

Moves the text cursor forward by one.

Arguments

• text_cursor - A mutable reference to the current text cursor position.

Returns

true if the cursor was successfully moved forward, false otherwise.

Examples

use text_editing::TextLine;

let line = TextLine::from_string("Hello, world!".into());
let mut text_cursor = 6;
assert!(line.forward(&mut text_cursor));
assert_eq!(text_cursor, 7);

pub fn backward(&self, text_cursor: &mut usize) -> bool

Moves the text cursor backward by one.

Arguments

• text_cursor - A mutable reference to the current text cursor position.

Returns

true if the cursor was successfully moved backward, false otherwise.

Examples

use text_editing::TextLine;

let line = TextLine::from_string("Hello, world!".into());
let mut text_cursor = 7;
assert!(line.backward(&mut text_cursor));
assert_eq!(text_cursor, 6);

pub fn skip_forward(&self, text_cursor: &mut usize) -> bool

Moves the text cursor forward until the end of the current word.

Arguments

• text_cursor - A mutable reference to the current text cursor position.

Returns

true if the cursor was successfully moved to the end of the word, false otherwise.

Examples

use text_editing::TextLine;

let line = TextLine::from_string("Hello, world!".into());
let mut text_cursor = 6;
assert!(line.skip_forward(&mut text_cursor));
assert_eq!(text_cursor, 12);

pub fn skip_backward(&self, text_cursor: &mut usize) -> bool

Moves the text cursor back until the start of the current word.

Arguments

• text_cursor - A mutable reference to the current text cursor position.

Returns

true if the cursor was successfully moved to the start of the word, false otherwise.

Examples

use text_editing::TextLine;

let line = TextLine::from_string("Hello, world!".into());
let mut text_cursor = 10;
assert!(line.skip_backward(&mut text_cursor));
assert_eq!(text_cursor, 7);

impl TextLine

pub fn add_char(&mut self, text_cursor: &mut usize, c: char)

Adds a char at the current text cursor position.

Arguments

• text_cursor - A mutable reference to the current text cursor position.
• c - The char to add.

Examples

use text_editing::TextLine;

let mut line = TextLine::from_string("Hello, ".into());
let mut text_cursor = 7;
line.add_char(&mut text_cursor, 'w');
assert_eq!(line.as_str(), "Hello, w");
assert_eq!(text_cursor, 8);

pub fn remove_forward(&mut self, text_cursor: usize) -> bool

Removes the next char at the current text cursor position, if it exists.

Arguments

• text_cursor - The current text cursor position.

Returns

true if a char was removed, false otherwise.

Examples

use text_editing::TextLine;

let mut line = TextLine::from_string("Hello, world!".into());
let text_cursor = 7;
assert!(line.remove_forward(text_cursor));
assert_eq!(line.as_str(), "Hello, orld!");

pub fn remove_forward_skip(&mut self, text_cursor: usize) -> bool

Removes the next word at the current text cursor position, if it exists.

Arguments

• text_cursor - The current text cursor position.

Returns

true if a word was removed, false otherwise.

Examples

use text_editing::TextLine;

let mut line = TextLine::from_string("Hello, world!".into());
let text_cursor = 7;
assert!(line.remove_forward_skip(text_cursor));
assert_eq!(line.as_str(), "Hello, !");

pub fn remove_backward(&mut self, text_cursor: &mut usize) -> bool

Removes the previous char at the current text cursor position, if it exists, and updates the text cursor.

Arguments

• text_cursor - A mutable reference to the current text cursor position.

Returns

true if a char was removed, false otherwise.

Examples

use text_editing::TextLine;

let mut line = TextLine::from_string("Hello, world!".into());
let mut text_cursor = 7;
assert!(line.remove_backward(&mut text_cursor));
assert_eq!(line.as_str(), "Hello,world!");
assert_eq!(text_cursor, 6);

pub fn remove_backward_skip(&mut self, text_cursor: &mut usize) -> bool

Removes the previous word at the current text cursor position, if it exists, and updates the text cursor.

Arguments

• text_cursor - A mutable reference to the current text cursor position.

Returns

true if a word was removed, false otherwise.

Examples

use text_editing::TextLine;

let mut line = TextLine::from_string("Hello, world!".into());
let mut text_cursor = 12;
assert!(line.remove_backward_skip(&mut text_cursor));
assert_eq!(line.as_str(), "Hello, !");
assert_eq!(text_cursor, 7);

impl TextLine

pub fn new() -> Self

Creates a new empty text line.

Examples

use text_editing::TextLine;

let line = TextLine::new();
assert!(line.is_empty());

pub fn from_string(text: String) -> Self

Creates a text line from a String.

Arguments

• text - The string to create the text line from.

Examples

use text_editing::TextLine;

let line = TextLine::from_string("Hello, world!".into());
assert_eq!(line.as_str(), "Hello, world!");

pub fn is_empty(&self) -> bool

Checks if the line is empty.

Returns

true if the line is empty, false otherwise.

Examples

use text_editing::TextLine;

let line = TextLine::new();
assert!(line.is_empty());

pub fn len(&self) -> usize

Returns the length of the text line.

Returns

The length of the text line.

Examples

use text_editing::TextLine;

let line = TextLine::from_string("Hello, world!".into());
assert_eq!(line.len(), 13);

pub fn as_str(&self) -> &str

Returns the text of the text line as a str reference.

Returns

A str reference to the text of the text line.

Examples

use text_editing::TextLine;

let line = TextLine::from_string("Hello, world!".into());
assert_eq!(line.as_str(), "Hello, world!");

pub fn string_index(&self, index: usize) -> usize

Converts the character index to the string index.

Arguments

• index - The character index to convert.

Returns

The corresponding string index.

Examples

use text_editing::TextLine;

let line = TextLine::from_string("Hello, world!".into());
assert_eq!(line.string_index(7), 7);

pub fn char_at(&self, at: usize) -> char

Returns the char at the specified position.

Arguments

• at - The position to retrieve the char from.

Panics

Panics if the position is out of bounds.

Examples

use text_editing::TextLine;

let line = TextLine::from_string("Hello, world!".into());
assert_eq!(line.char_at(7), 'w');

pub fn insert(&mut self, index: usize, c: char)

Inserts a new char into the text line.

Arguments

• index - The position to insert the char at.
• c - The char to insert.

Examples

use text_editing::TextLine;

let mut line = TextLine::from_string("Hello, orld!".into());
line.insert(7, 'w');
assert_eq!(line.as_str(), "Hello, world!");

pub fn remove(&mut self, index: usize) -> char

Removes a char from the text line.

Arguments

• index - The position to remove the char from.

Returns

The removed char.

Examples

use text_editing::TextLine;

let mut line = TextLine::from_string("Hello, world!".into());
assert_eq!(line.remove(7), 'w');
assert_eq!(line.as_str(), "Hello, orld!");

pub fn remove_range(&mut self, range: Range<usize>)

Removes the specified range from the text line.

Arguments

• range - The range to remove.

Examples

use text_editing::TextLine;

let mut line = TextLine::from_string("Hello, world!".into());
line.remove_range(7..12);
assert_eq!(line.as_str(), "Hello, !");

pub fn split(&mut self, index: usize) -> Self

Splits a text line into two.

Arguments

• index - The position to split the text line at.

Returns

The new text line containing the text after the split position.

Examples

use text_editing::TextLine;

let mut line = TextLine::from_string("Hello, world!".into());
let second_half = line.split(7);
assert_eq!(line.as_str(), "Hello, ");
assert_eq!(second_half.as_str(), "world!");

pub fn join(&mut self, other: Self)

Joins two text lines into one.

Arguments

• other - The text line to append to the current text line.

Examples

use text_editing::TextLine;

let mut line1 = TextLine::from_string("Hello, ".into());
let line2 = TextLine::from_string("world!".into());
line1.join(line2);
assert_eq!(line1.as_str(), "Hello, world!");

Trait Implementations

impl Clone for TextLine

fn clone(&self) -> TextLine

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for TextLine

fn default() -> TextLine

Returns the “default value” for a type.

impl Display for TextLine

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

Formats the value using the given formatter.

impl From<String> for TextLine

fn from(text: String) -> Self

Converts to this type from the input type.

impl From<TextLine> for String

fn from(text_line: TextLine) -> Self

Converts to this type from the input type.

impl FromStr for TextLine

type Err = Infallible

The associated error which can be returned from parsing.

fn from_str(text: &str) -> Result<Self, Infallible>

Parses a string s to return a value of this type.