Struct TextRange 

pub struct TextRange { /* private fields */ }

A range in the source text [start, end), represented as byte offsets.

Stores only offsets.

Implementations

impl TextRange

pub const fn new(start: TextSize, end: TextSize) -> Self

Creates a new range from start (inclusive) and end (exclusive) offsets.

pub const fn empty() -> Self

Creates an empty range at offset 0.

pub const fn start(self) -> TextSize

Start offset (inclusive).

pub const fn end(self) -> TextSize

End offset (exclusive).

pub const fn len(self) -> TextSize

Length of the range in bytes.

pub const fn is_empty(self) -> bool

Whether the range is empty.

pub const fn contains(self, offset: TextSize) -> bool

Whether offset is contained in this range.

pub const fn from_offset_len(offset: usize, len: usize) -> Self

Creates a range from an absolute byte offset and a length.

pub fn source_text<'a>(&self, source: &'a str) -> &'a str

Extracts the corresponding slice from the source text.

Returns an empty string if the range is empty or offsets are out of bounds.

Examples found in repository

examples/parse_numpy.rs (line 48)

fn main() {
    let docstring = r#"
Calculate the area of a rectangle.

This function takes the width and height of a rectangle
and returns its area.

Parameters
----------
width : float
    The width of the rectangle.
height : float
    The height of the rectangle.

Returns
-------
float
    The area of the rectangle.

Raises
------
ValueError
    If width or height is negative.

Examples
--------
>>> calculate_area(5.0, 3.0)
15.0
"#;

    let parsed = parse_numpy(docstring);
    let doc = NumPyDocstring::cast(parsed.root()).unwrap();

    println!("╔══════════════════════════════════════════════════╗");
    println!("║          NumPy-style Docstring Example           ║");
    println!("╚══════════════════════════════════════════════════╝");

    println!();

    // Display: raw source text
    println!("── raw text ────────────────────────────────────────");
    println!("{}", doc.syntax().range().source_text(parsed.source()));

    println!();

    // pretty_print: structured AST
    println!("── parsed AST ──────────────────────────────────────");
    print!("{}", parsed.pretty_print());
}

pub fn extend(&mut self, other: TextRange)

Extend this range to include other.

If self is empty, it is set to other. Otherwise its end is extended to other.end().

Trait Implementations

impl Clone for TextRange

fn clone(&self) -> TextRange

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TextRange

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

Formats the value using the given formatter.

impl Default for TextRange

fn default() -> TextRange

Returns the “default value” for a type.

impl Display for TextRange

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

Formats the value using the given formatter.

impl Hash for TextRange

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for TextRange

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

impl Eq for TextRange

impl StructuralPartialEq for TextRange