Struct TwoPoints 

pub struct TwoPoints {
    pub real: Point,
    pub ghost: Option<Point>,
}

A struct used to exactly pinpoint a position in Text, used when printing.

This struct has two inner components, a real Point, and a ghost Option<Point>. The second component is used whenever you want to print a Ghost Text, either fully or partially.

The ghost component represents the “sum position” of all Ghosts in that same byte. For example if there are two ghosts in a single byte, if you pass ghost == ghost1.len(), then only the second ghost will be included in this iteration.

TwoPoints::default will include the first Ghost.

Fields

real: Point

The real Point in the Text.

ghost: Option<Point>

A possible point in a Ghost.

A value of None means that this is either at the end of the ghosts at a byte (i.e. this TwoPoints represents a real character), or this byte index doesn’t have any ghosts at all.

A value of Some means that this TwoPoints does not represent a real character, so it points to a character belonging to a Ghost

If you don’t know how to set this value, you should try to use the new, new_before_ghost or new_after_ghost functions.

Implementations

impl TwoPoints

pub const fn new(real: Point, ghost: Point) -> Self

Returns a fully qualified TwoPoints.

This will include a precise real Point as well as a precise ghost Point.

If you don’t want to deal with ghosts, see TwoPoints::new_before_ghost and TwoPoints::new_after_ghost.

pub const fn new_before_ghost(real: Point) -> Self

Returns a new TwoPoints that will include the Ghost before the real Point.

pub const fn new_after_ghost(real: Point) -> Self

Returns a new TwoPoints that will exclude the Ghost before the real Point.

Trait Implementations

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

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 TwoPoints

fn clone(&self) -> TwoPoints

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TwoPoints

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

Formats the value using the given formatter.

impl<__Context> Decode<__Context> for TwoPoints

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

Attempt to decode this type with the given Decode.

impl Default for TwoPoints

fn default() -> TwoPoints

Returns the “default value” for a type.

impl Encode for TwoPoints

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

Encode a given type.

impl Hash for TwoPoints

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 TwoPoints

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 TwoPoints

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

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 TwoPoints

impl Eq for TwoPoints

impl StructuralPartialEq for TwoPoints