Struct Cursor 

pub struct Cursor { /* private fields */ }

Cursor position and shape.

Implementations

impl Cursor

pub fn new(shape: CursorShape, column: usize, row: usize) -> Self

pub fn shape(&self) -> CursorShape

pub fn pos(&self) -> (usize, usize)

Returns the cursor position as a tuple (column, row).

pub fn set(&mut self, col: usize, row: usize)

pub fn set_col(&mut self, col: usize)

pub fn col(&self) -> usize

pub fn inc_col(&mut self, value: usize)

pub fn dec_col(&mut self, value: usize)

pub fn row(&self) -> usize

pub fn set_row(&mut self, row: usize)

pub fn inc_row(&mut self, value: usize)

pub fn dec_row(&mut self, value: usize)

pub fn offset(&self, column_offset: isize, row_offset: isize) -> (usize, usize)

Calculates the cursor position after applying specified offsets.

pub fn is_caret(&self) -> bool

Returns true when the current cursor shape is a bar (│).

pub fn is_block(&self) -> bool

Returns true when the current cursor shape is a block (█).

pub fn is_under_score(&self) -> bool

Returns true when the current cursor shape is an underscore (_).

pub fn insert_mode(&self) -> bool

Returns true when the cursor is signaling the inserting mode.

pub fn override_mode(&self) -> bool

Returns true when the cursor is signaling the overriding mode.

pub fn toggle_caret_block(&mut self) -> CursorShape

Toggles the cursor shape between caret and block.

Returns the cursor shape after toggling.

Examples

use dtee::{Cursor, CursorShape};

let mut cursor = Cursor::new(CursorShape::Caret, 1, 1);
assert_eq!(true, cursor.is_caret());

assert_eq!(CursorShape::Block, cursor.toggle_caret_block());
assert_eq!(CursorShape::Caret, cursor.toggle_caret_block());

let mut cursor = Cursor::new(CursorShape::UnderScore, 1, 1);
assert_eq!(true, cursor.is_under_score());

assert_eq!(CursorShape::Block, cursor.toggle_caret_block());
assert_eq!(CursorShape::Caret, cursor.toggle_caret_block());

pub fn toggle_caret_under_score(&mut self) -> CursorShape

Toggles the cursor shape between caret and underscore.

Returns the cursor shape after toggling.

Examples

use dtee::{Cursor, CursorShape};

let mut cursor = Cursor::new(CursorShape::Caret, 1, 1);
assert_eq!(true, cursor.is_caret());

assert_eq!(CursorShape::UnderScore, cursor.toggle_caret_under_score());
assert_eq!(CursorShape::Caret, cursor.toggle_caret_under_score());

let mut cursor = Cursor::new(CursorShape::Block, 1, 1);
assert_eq!(true, cursor.is_block());

assert_eq!(CursorShape::UnderScore, cursor.toggle_caret_under_score());
assert_eq!(CursorShape::Caret, cursor.toggle_caret_under_score());

Trait Implementations

impl Clone for Cursor

fn clone(&self) -> Cursor

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Cursor

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

Formats the value using the given formatter.

impl PartialEq for Cursor

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for Cursor

impl Eq for Cursor

impl StructuralPartialEq for Cursor