syntax

Struct TextSize

pub struct TextSize { /* private fields */ }
Expand description

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.

Implementations§

§

impl TextSize

pub const fn new(raw: u32) -> TextSize

Creates a new instance of TextSize from a raw u32.

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

The text size of some primitive text-like object.

Accepts char, &str, and &String.

§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 const fn checked_add(self, rhs: TextSize) -> Option<TextSize>

Checked addition. Returns None if overflow occurred.

pub const 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. Read more
§

impl Add<&TextSize> for TextSize

§

type Output = TextSize

The resulting type after applying the + operator.
§

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

Performs the + operation. Read more
§

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

§

type Output = TextSize

The resulting type after applying the + operator.
§

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

Performs the + operation. Read more
§

impl Add<TextSize> for TextRange

§

type Output = TextRange

The resulting type after applying the + operator.
§

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

Performs the + operation. Read more
§

impl Add for TextSize

§

type Output = TextSize

The resulting type after applying the + operator.
§

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

Performs the + operation. Read more
§

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

§

fn add_assign(&mut self, rhs: A)

Performs the += operation. Read more
§

impl AddAssign<Delta<TextSize>> for TextSize

§

fn add_assign(&mut self, rhs: Delta<TextSize>)

Performs the += operation. Read more
§

impl Clone for TextSize

§

fn clone(&self) -> TextSize

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
§

impl Debug for TextSize

§

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

Formats the value using the given formatter. Read more
§

impl Default for TextSize

§

fn default() -> TextSize

Returns the “default value” for a type. Read more
§

impl From<u32> for TextSize

§

fn from(raw: u32) -> TextSize

Converts to this type from the input type.
§

impl Hash for TextSize

§

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

Feeds this value into the given Hasher. Read more
1.3.0 · source§

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

Feeds a slice of this type into the given Hasher. Read more
§

impl Ord for TextSize

§

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

This method returns an Ordering between self and other. Read more
1.21.0 · source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · source§

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

Restrict a value to a certain interval. Read more
§

impl PartialEq for TextSize

§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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 TextSize

§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
§

impl RangeBounds<TextSize> for TextRange

§

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

Start index bound. Read more
§

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

End index bound. Read more
1.35.0 · source§

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

Returns true if item is contained in the range. Read more
§

impl Sub<&TextSize> for TextRange

§

type Output = TextRange

The resulting type after applying the - operator.
§

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

Performs the - operation. Read more
§

impl Sub<&TextSize> for TextSize

§

type Output = TextSize

The resulting type after applying the - operator.
§

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

Performs the - operation. Read more
§

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

§

type Output = TextSize

The resulting type after applying the - operator.
§

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

Performs the - operation. Read more
§

impl Sub<TextSize> for TextRange

§

type Output = TextRange

The resulting type after applying the - operator.
§

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

Performs the - operation. Read more
§

impl Sub for TextSize

§

type Output = TextSize

The resulting type after applying the - operator.
§

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

Performs the - operation. Read more
§

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

§

fn sub_assign(&mut self, rhs: S)

Performs the -= operation. Read more
§

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

§

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

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.
§

impl Copy for TextSize

§

impl Eq for TextSize

§

impl StructuralPartialEq for TextSize

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoBox<dyn Any> for T
where T: Any,

source§

fn into_box(self) -> Box<dyn Any>

Convert self into the appropriate boxed form.
source§

impl<T> IntoBox<dyn Any + Send> for T
where T: Any + Send,

source§

fn into_box(self) -> Box<dyn Any + Send>

Convert self into the appropriate boxed form.
source§

impl<T> IntoBox<dyn Any + Sync + Send> for T
where T: Any + Send + Sync,

source§

fn into_box(self) -> Box<dyn Any + Sync + Send>

Convert self into the appropriate boxed form.
source§

impl<T> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

impl<T> ToOwned for T
where T: Clone,

source§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

source§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more