Enum Dot 

pub enum Dot {
    Cur {
        c: Cur,
    },
    Range {
        r: Range,
    },
}

A Dot represents the currently selected contents of a Buffer.

Most of the editing commands available in ad which manipulate the buffer contents do so via setting and manipulating the current dot. The name comes from the fact that the representation of the current Dot in the editing language is .

Variants

Cur

A single character Cur

Fields

c: Cur

The cursor

Range

A Range between two cursors

Fields

r: Range

The range

Implementations

impl Dot

pub fn from_char_indices(from: usize, to: usize) -> Self

Construct a new Range dot from two cursor indices.

to will be used as the active cursor position.

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

Convert a Dot into character offsets within the buffer idendifying its start and end positions.

For a Cur dot the start and end are equal

pub fn n_chars(&self) -> usize

The number of characters contained within this Dot.

pub fn is_cur(&self) -> bool

Whether or not this dot is a Cur.

pub fn is_range(&self) -> bool

Whether or not this dot is a Range.

pub fn contains(&self, cur: &Cur) -> bool

Whether or not this dot contains cur within it.

pub fn contains_range(&self, rng: &Range) -> bool

Whether or not this dot contains all of rng within it.

pub fn with_offset_saturating(self, offset: isize) -> Self

Apply an offset to the cursors within this Dot using saturating subtraction.

Dot::clamp_idx will still need to be called in order to ensure that the result is within bounds for the given buffer.

pub fn addr(&self, b: &Buffer) -> String

The address representation of this dot in the form that is enterable by the user. Indices are 1-based rather than their internal 0-based representation.

pub fn content(&self, b: &Buffer) -> String

Use this Dot to index in to a Buffer and extract the range of text it denotes.

pub fn active_cur(&self) -> Cur

The active cursor position for this Dot which will be manipulated by movement operations

pub fn set_active_cur(&mut self, cur: Cur)

Set the active cursor position for this Dot directly, replacing the current active cursor.

pub fn first_cur(&self) -> Cur

The cursor position closest to the start of the Buffer.

pub fn last_cur(&self) -> Cur

The cursor position closest to the end of the Buffer.

pub fn as_range(&self) -> Range

This Dot expressed as a Range.

For range dots the underlying range is returned directly. For cursor dots a new range is constructed where start and end are equal and the end is the active cursor.

pub fn collapse_to_first_cur(&self) -> Self

The Dot equivalent of Dot::first_cur.

pub fn collapse_to_last_cur(&self) -> Self

The Dot equivalent of Dot::last_cur.

pub fn collapse_to_active_cur(&self) -> Self

The Dot equivalent of Dot::active_cur.

pub fn flip(&mut self)

Swap the active cursor between start and end of Range dots.

pub fn collapse_null_range(self) -> Self

If both ends of a Range match then replace with a single Cur

pub fn clamp_idx(&mut self, max_idx: usize)

Clamp this dot to be valid for the given Buffer

Trait Implementations

impl Clone for Dot

fn clone(&self) -> Dot

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Dot

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

Formats the value using the given formatter.

impl Default for Dot

fn default() -> Self

Returns the “default value” for a type.

impl From<Cur> for Dot

fn from(c: Cur) -> Self

Converts to this type from the input type.

impl From<Range> for Dot

fn from(r: Range) -> Self

Converts to this type from the input type.

impl Ord for Dot

fn cmp(&self, other: &Dot) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Dot

fn eq(&self, other: &Dot) -> 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 PartialOrd for Dot

fn partial_cmp(&self, other: &Dot) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for Dot

impl Eq for Dot

impl StructuralPartialEq for Dot