Struct Range

pub struct Range {
    pub start: usize,
    pub end: usize,
    pub style: Style,
}

Represents a character range with an associated style for selective text styling.

A Range specifies a half-open interval [start, end) of character positions and the style to apply to that text segment. This enables sophisticated text styling like syntax highlighting, search result highlighting, or selective formatting.

Character Indexing

Indices are based on Unicode scalar values (Rust char), which closely matches the rune-based indexing of the original Go implementation. This means:

• ASCII characters count as 1 index each
• Multi-byte Unicode characters (including CJK) count as 1 index each
• Emoji and other complex characters count as 1 index each

Range Behavior

• Half-open: Range [2, 5) includes characters at positions 2, 3, 4 (not 5)
• Clamping: Out-of-bounds indices are automatically clamped to valid range
• Invalid ranges: Empty ranges (start >= end) are ignored
• Overlapping: Later ranges override earlier ones in the same positions

Examples

use lipgloss::{Style, Color, utils::Range};

// Create a range to make characters 0-5 bold
let bold_style = Style::new().bold(true);
let range = Range::new(0, 5, bold_style);

// Multiple ranges for different styling
let red_style = Style::new().foreground("red");
let blue_style = Style::new().foreground("blue");

let ranges = vec![
    Range::new(0, 5, red_style),    // "Hello" in red
    Range::new(6, 11, blue_style),  // "World" in blue
];

// Ranges work with Unicode text
let text = "Hello 世界";
let unicode_range = Range::new(6, 8, Style::new().bold(true));  // Style the CJK characters

Fields

start: usize

The starting character index (inclusive)

end: usize

The ending character index (exclusive)

style: Style

The style to apply to this range

Implementations

impl Range

pub fn new(start: usize, end: usize, style: Style) -> Self

Creates a new Range with the specified character positions and style.

Arguments

• start - The starting character index (inclusive)
• end - The ending character index (exclusive)
• style - The style to apply to characters in this range

Returns

A new Range instance

Examples

use lipgloss::{Style, Color, utils::Range};

let style = Style::new().foreground("red").bold(true);
let range = Range::new(0, 5, style);

assert_eq!(range.start, 0);
assert_eq!(range.end, 5);

Trait Implementations

impl Clone for Range

fn clone(&self) -> Range

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Range

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

Formats the value using the given formatter.