Struct StringRange 

pub struct StringRange {
    pub start_offset: u32,
    pub end_offset: u32,
}

Identifies a substring within a given text using character offsets.

Uses zero-based Unicode character offsets where start_offset is inclusive and end_offset is exclusive.

Commonly used in autocomplete responses to indicate which portions of text matched the user’s input, allowing UI highlighting of relevant segments.

Note: Offsets are Unicode character positions, not byte positions, which is important for proper handling of multi-byte characters.

Fields

start_offset: u32

Zero-based offset of the first Unicode character (inclusive).

The starting position of the substring within the parent text.

end_offset: u32

Zero-based offset of the last Unicode character (exclusive).

The ending position of the substring, where the character at this position is not included in the range.

Implementations

impl StringRange

pub fn start_offset(&self) -> &u32

Zero-based offset of the first Unicode character (inclusive).

The starting position of the substring within the parent text.

pub fn end_offset(&self) -> &u32

Zero-based offset of the last Unicode character (exclusive).

The ending position of the substring, where the character at this position is not included in the range.

impl StringRange

pub fn start_offset_mut(&mut self) -> &mut u32

Zero-based offset of the first Unicode character (inclusive).

The starting position of the substring within the parent text.

pub fn end_offset_mut(&mut self) -> &mut u32

Zero-based offset of the last Unicode character (exclusive).

The ending position of the substring, where the character at this position is not included in the range.

impl StringRange

pub fn set_start_offset(&mut self, val: u32) -> &mut Self

Zero-based offset of the first Unicode character (inclusive).

The starting position of the substring within the parent text.

pub fn set_end_offset(&mut self, val: u32) -> &mut Self

Zero-based offset of the last Unicode character (exclusive).

The ending position of the substring, where the character at this position is not included in the range.

impl StringRange

pub fn builder() -> StringRangeBuilder

Create an instance of StringRange using the builder syntax

impl StringRange

pub const fn new(start_offset: u32, end_offset: u32) -> Self

Creates a new StringRange from start and end offsets.

Creates a range where start_offset is inclusive and end_offset is exclusive, matching standard range semantics.

Use this when constructing ranges from API responses or when manually specifying text segments to highlight.

pub const fn start(self) -> u32

Returns the start offset (inclusive).

The zero-based Unicode character position where the range begins.

pub const fn end(self) -> u32

Returns the end offset (exclusive).

The zero-based Unicode character position where the range ends. The character at this position is not included in the range.

pub const fn len(self) -> u32

Returns the length of the range in characters.

Calculates the number of Unicode characters covered by this range.

Use this to determine how many characters to highlight or extract.

pub const fn is_empty(self) -> bool

Checks if the range is empty (zero length).

Returns true if the start and end offsets are equal, indicating a zero-length range that covers no characters.

pub const fn range(self) -> Range<usize>

Converts to a Rust standard Range<usize>.

Creates a Range<usize> for use with string slicing operations.

Use this when you need to extract or highlight the substring using Rust’s standard range syntax. Returns None if either offset is negative.

Trait Implementations

impl Clone for StringRange

fn clone(&self) -> StringRange

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StringRange

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for StringRange

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for StringRange

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

Formats the range as [start..end].

Uses Rust’s standard range notation for machine-readable output. Suitable for debugging, logging, and serialization to text formats.

impl From<&Range<usize>> for StringRange

fn from(range: &Range<usize>) -> Self

Converts a borrowed &Range<usize> to a StringRange.

Creates a StringRange from a borrowed standard Rust range.

Use this when you want to convert a range reference without consuming the original.

impl From<Range<usize>> for StringRange

fn from(range: Range<usize>) -> Self

Converts a Rust Range<usize> to a StringRange.

Creates a StringRange from a standard Rust range.

Use this when constructing API requests from range-based string operations or when you have computed offsets using Rust’s range syntax.

impl PartialEq for StringRange

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&StringRange> for Range<usize>

fn try_from(string_range: &StringRange) -> Result<Self, Self::Error>

Converts a borrowed &StringRange to a Rust Range<usize>.

Attempts to convert the StringRange offsets to usize for use with string slicing without consuming the original.

Errors

Returns an error if either offset is negative or too large to fit in a usize.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<StringRange> for Range<usize>

fn try_from(string_range: StringRange) -> Result<Self, Self::Error>

Converts a StringRange to a Rust Range<usize>.

Attempts to convert the StringRange offsets to usize for use with string slicing.

Errors

Returns an error if either offset is negative or too large to fit in a usize.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl Copy for StringRange

impl Eq for StringRange

impl StructuralPartialEq for StringRange