Struct VPoint 

pub struct VPoint { /* private fields */ }

A visual Point, which includes more information

Alongside the byte, char, and line of the Point, this struct has:

• Number of chars from the left edge
• Number of visual cells from the left edge
• Desired number of visual cells from the left edge
• Number of wrapped cells from the left edge
• Desired number of wrapped cells from the left edge

The difference between visual cells and wrapped cells is that visual cells are essentially “The distance a Point would be if this line were not wrapped”

Desired cells are used when moving vertically, since when you move a Selection up or down to a shorter line, then to a longer one, you expect the horizontal position to hold. This is applied both in full line and wrapped line vertical movement.

Implementations

impl VPoint

pub fn byte(&self) -> usize

The byte index of this VPoint

pub fn char(&self) -> usize

The char index of this VPoint

pub fn line(&self) -> usize

The line index of this VPoint

pub fn char_col(&self) -> usize

Number of characters from the start of the line

pub fn visual_col(&self) -> usize

Total space from the start of the line

pub fn desired_visual_col(&self) -> usize

How much space there should be from the start of the line

pub fn wrapped_col(&self) -> usize

Total space from the left edge

pub fn desired_wrapped_col(&self) -> usize

How much space there should be from the left edge

Trait Implementations

impl<'__de, __Context> BorrowDecode<'__de, __Context> for VPoint

fn borrow_decode<__D: BorrowDecoder<'__de, Context = __Context>>( decoder: &mut __D, ) -> Result<Self, DecodeError>

Attempt to decode this type with the given BorrowDecode.

impl Clone for VPoint

fn clone(&self) -> VPoint

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VPoint

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

Formats the value using the given formatter.

impl<__Context> Decode<__Context> for VPoint

fn decode<__D: Decoder<Context = __Context>>( decoder: &mut __D, ) -> Result<Self, DecodeError>

Attempt to decode this type with the given Decode.

impl Encode for VPoint

fn encode<__E: Encoder>(&self, encoder: &mut __E) -> Result<(), EncodeError>

Encode a given type.

impl Ord for VPoint

fn cmp(&self, other: &Self) -> 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 VPoint

fn eq(&self, other: &Self) -> 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 VPoint

fn partial_cmp(&self, other: &Self) -> 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 VPoint

impl Eq for VPoint