Struct enso_data::text::Index

pub struct Index {
    pub value: usize,
}

====================================== === Text Coordinates And Distances ===

Strongly typed index into container.

Fields

value: usize

Implementations

impl Index

pub fn new(value: usize) -> Self

Initializes Index with given value.

pub fn convert_byte_index(content: impl Str, index: ByteIndex) -> Self

Create char index from the byte index. It must traverse the content to count chars.

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

Checked subtraction. Computes self - rhs, returning None if overflow occurred.

Trait Implementations

impl Add<Size> for Index

type Output = Index

The resulting type after applying the + operator.

fn add(self, rhs: Size) -> Index

Performs the + operation.

impl AddAssign<Size> for Index

fn add_assign(&mut self, rhs: Size)

Performs the += operation.

impl Clone for Index

fn clone(&self) -> Index

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Index

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

Formats the value using the given formatter.

impl Default for Index

fn default() -> Index

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Index

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Display for Index

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

Formats the value using the given formatter.

impl Hash for Index

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, 

Feeds a slice of this type into the given Hasher.

impl Ord for Index

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

This method returns an Ordering between self and other.

#[must_use]

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

Compares and returns the maximum of two values.

#[must_use]

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

Compares and returns the minimum of two values.

#[must_use]

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

Restrict a value to a certain interval.

impl PartialEq<Index> for Index

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<Index> for Index

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

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

#[must_use]

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

This method tests less than (for self and other) and is used by the < operator.

#[must_use]

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

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

#[must_use]

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

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]

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

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

impl Serialize for Index

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl Sub<Index> for Index

type Output = Size

The resulting type after applying the - operator.

fn sub(self, rhs: Index) -> Size

Performs the - operation.

impl Sub<Size> for Index

type Output = Index

The resulting type after applying the - operator.

fn sub(self, rhs: Size) -> Index

Performs the - operation.

impl SubAssign<Size> for Index

fn sub_assign(&mut self, rhs: Size)

Performs the -= operation.

impl Copy for Index

impl Eq for Index

impl StructuralEq for Index

impl StructuralPartialEq for Index