Struct rowan::TextSize

pub struct TextSize { /* fields omitted */ }

A measure of text length. Also, equivalently, an index into text.

This is a UTF-8 bytes offset stored as u32, but most clients should treat it as an opaque measure.

For cases that need to escape TextSize and return to working directly with primitive integers, TextSize can be converted losslessly to/from u32 via From conversions as well as losslessly be converted Into usize. The usize -> TextSize direction can be done via [TryFrom].

These escape hatches are primarily required for unit testing and when converting from UTF-8 size to another coordinate space, such as UTF-16.

Methods

impl TextSize

pub fn of<T>(text: T) -> TextSize where
    T: TextLen, 

The text size of some text-like object.

Accepts char, &str, and references to any custom string-like type that dereferences to str. Types that don't dereference to str but want to be usable in this constructor can implement TextLen.

Examples

let char_size = TextSize::of('🦀');
assert_eq!(char_size, TextSize::from(4));

let str_size = TextSize::of("rust-analyzer");
assert_eq!(str_size, TextSize::from(13));

impl TextSize

Methods to act like a primitive integer type, where reasonably applicable.

pub fn checked_add(self, rhs: TextSize) -> Option<TextSize>

Checked addition. Returns None if overflow occurred.

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

Checked subtraction. Returns None if overflow occurred.

Trait Implementations

impl<'_> Add<&'_ TextSize> for TextRange

type Output = TextRange

The resulting type after applying the + operator.

fn add(self, other: &TextSize) -> TextRange

Performs the + operation.

impl<'_> Add<&'_ TextSize> for TextSize

type Output = TextSize

The resulting type after applying the + operator.

fn add(self, other: &TextSize) -> TextSize

Performs the + operation.

impl<'_, T> Add<T> for &'_ TextSize where
    TextSize: Add<T>,
    <TextSize as Add<T>>::Output == TextSize, 

type Output = TextSize

The resulting type after applying the + operator.

fn add(self, other: T) -> TextSize

Performs the + operation.

impl Add<TextSize> for TextSize

type Output = TextSize

The resulting type after applying the + operator.

fn add(self, other: TextSize) -> TextSize

Performs the + operation.

impl Add<TextSize> for TextRange

type Output = TextRange

The resulting type after applying the + operator.

fn add(self, offset: TextSize) -> TextRange

Performs the + operation.

impl<A> AddAssign<A> for TextSize where
    TextSize: Add<A>,
    <TextSize as Add<A>>::Output == TextSize, 

fn add_assign(&mut self, rhs: A)

Performs the += operation.

impl Clone for TextSize

fn clone(&self) -> TextSize

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for TextSize

impl Debug for TextSize

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

Formats the value using the given formatter.

impl Default for TextSize

fn default() -> TextSize

Returns the "default value" for a type.

impl Eq for TextSize

impl From<u32> for TextSize

fn from(raw: u32) -> TextSize

Performs the conversion.

impl Hash for TextSize

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

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 TextSize

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

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<TextSize> for TextSize

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

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

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

This method tests for !=.

impl PartialOrd<TextSize> for TextSize

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

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

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

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

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

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

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

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

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

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

impl RangeBounds<TextSize> for TextRange

fn start_bound(&self) -> Bound<&TextSize>

Start index bound.

fn end_bound(&self) -> Bound<&TextSize>

End index bound.

fn contains<U>(&self, item: &U) -> bool where
    T: PartialOrd<U>,
    U: PartialOrd<T> + ?Sized, 

Returns true if item is contained in the range.

impl StructuralEq for TextSize

impl StructuralPartialEq for TextSize

impl<'_> Sub<&'_ TextSize> for TextSize

type Output = TextSize

The resulting type after applying the - operator.

fn sub(self, other: &TextSize) -> TextSize

Performs the - operation.

impl<'_> Sub<&'_ TextSize> for TextRange

type Output = TextRange

The resulting type after applying the - operator.

fn sub(self, other: &TextSize) -> TextRange

Performs the - operation.

impl<'_, T> Sub<T> for &'_ TextSize where
    TextSize: Sub<T>,
    <TextSize as Sub<T>>::Output == TextSize, 

type Output = TextSize

The resulting type after applying the - operator.

fn sub(self, other: T) -> TextSize

Performs the - operation.

impl Sub<TextSize> for TextSize

type Output = TextSize

The resulting type after applying the - operator.

fn sub(self, other: TextSize) -> TextSize

Performs the - operation.

impl Sub<TextSize> for TextRange

type Output = TextRange

The resulting type after applying the - operator.

fn sub(self, offset: TextSize) -> TextRange

Performs the - operation.

impl<S> SubAssign<S> for TextSize where
    TextSize: Sub<S>,
    <TextSize as Sub<S>>::Output == TextSize, 

fn sub_assign(&mut self, rhs: S)

Performs the -= operation.

impl<A> Sum<A> for TextSize where
    TextSize: Add<A>,
    <TextSize as Add<A>>::Output == TextSize, 

fn sum<I>(iter: I) -> TextSize where
    I: Iterator<Item = A>, 

Method which takes an iterator and generates Self from the elements by "summing up" the items.

impl TryFrom<usize> for TextSize

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(value: usize) -> Result<TextSize, TryFromIntError>

Performs the conversion.