Struct Point 

pub struct Point { /* private fields */ }

A position in Text

Implementations

impl Point

pub const fn new() -> Self

Returns a new Point, at the first byte

pub const fn from_raw(b: usize, c: usize, l: usize) -> Self

A Point from raw indices

pub const fn to_two_points_before(self) -> TwoPoints

Returns a new TwoPoints that includes the Ghosts in the same byte, if there is one

pub const fn to_two_points_after(self) -> TwoPoints

Returns a new TwoPoints that skips the Ghosts in the same byte, if there is one

pub fn len_of(str: impl AsRef<str>) -> Self

The len Point of a &str

This is the equivalent of Text::len, but for types other than Text

pub const fn byte(&self) -> usize

Returns the byte (relative to the beginning of the buffer) of self. Indexed at 0

You can use byte indices to index the Text or Bytes with the Bytes::point_at_byte function.

pub const fn char(&self) -> usize

Returns the char index (relative to the beginning of the buffer). Indexed at 0

This is the primary value used when indexing the Text and Bytes. That is, the Bytes::point_at_byte, Bytes::strs, and most other Bytes functions rely on a character indices (or Points) for indexing a Text.

pub const fn line(&self) -> usize

Returns the line. Indexed at 0

You can use byte indices to index the Text or Bytes with the Bytes::point_at_line function.

pub fn checked_sub(self, rhs: Point) -> Option<Point>

Checked Point subtraction

Trait Implementations

impl Add for Point

type Output = Point

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self::Output

Performs the + operation.

impl AddAssign for Point

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

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

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 Point

fn clone(&self) -> Point

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Point

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

Formats the value using the given formatter.

impl<__Context> Decode<__Context> for Point

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

Attempt to decode this type with the given Decode.

impl Default for Point

fn default() -> Point

Returns the “default value” for a type.

impl Display for Point

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

Formats the value using the given formatter.

impl Encode for Point

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

Encode a given type.

impl Hash for Point

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Point

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

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

fn partial_cmp(&self, other: &Point) -> 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 Sub for Point

type Output = Point

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Self::Output

Performs the - operation.

impl SubAssign for Point

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl Tag<Point> for ExtraCaret

const IS_META: bool = false

A meta Tag is one that changes the layout of the Text itself

impl Tag<Point> for MainCaret

const IS_META: bool = false

A meta Tag is one that changes the layout of the Text itself

impl Tag<Point> for Spacer

const IS_META: bool = false

A meta Tag is one that changes the layout of the Text itself

impl Tag<Point, GhostId> for Ghost

const IS_META: bool = true

A meta Tag is one that changes the layout of the Text itself

impl Tag<Point, SpawnId> for SpawnTag

const IS_META: bool = false

A meta Tag is one that changes the layout of the Text itself

impl TextIndex for Point

fn to_byte_index(self) -> usize

Converts this type into a byte index.

impl TextRangeOrIndex for Point

fn to_range(self, max: usize) -> Range<usize>

Transforms self into a Range<usize>

impl CaretOrRange for Point

impl Copy for Point

impl Eq for Point

impl StructuralPartialEq for Point