Struct Locator 

pub struct Locator<'a> { /* private fields */ }

Implementations

impl<'a> Locator<'a>

pub const fn new(contents: &'a str) -> Self

pub fn to_index(&self) -> &LineIndex

pub fn to_source_code(&self) -> SourceCode<'_, '_>

pub fn floor_char_boundary(&self, offset: TextSize) -> TextSize

Finds the closest TextSize not exceeding the offset for which is_char_boundary is true.

Examples

let locator = Locator::new("Hello");

assert_eq!(
    locator.floor_char_boundary(TextSize::from(0)),
    TextSize::from(0)
);

assert_eq!(
    locator.floor_char_boundary(TextSize::from(5)),
    TextSize::from(5)
);

let locator = Locator::new("α");

assert_eq!(
    locator.floor_char_boundary(TextSize::from(0)),
    TextSize::from(0)
);

assert_eq!(
    locator.floor_char_boundary(TextSize::from(1)),
    TextSize::from(0)
);

assert_eq!(
    locator.floor_char_boundary(TextSize::from(2)),
    TextSize::from(2)
);

pub const fn contents(&self) -> &'a str

Return the underlying source code.

Trait Implementations

impl<'a> Debug for Locator<'a>

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

Formats the value using the given formatter.

impl LineRanges for Locator<'_>

fn line_start(&self, offset: TextSize) -> TextSize

Computes the start position of the line of offset.

fn bom_start_offset(&self) -> TextSize

Computes the start position of the file contents: either the first byte, or the byte after the BOM.

fn full_line_end(&self, offset: TextSize) -> TextSize

Computes the offset that is right after the newline character that ends offset’s line.

fn line_end(&self, offset: TextSize) -> TextSize

Computes the offset that is right before the newline character that ends offset’s line.

fn full_line_str(&self, offset: TextSize) -> &str

Returns the text of the offset’s line.

fn line_str(&self, offset: TextSize) -> &str

Returns the text of the offset’s line.

fn contains_line_break(&self, range: TextRange) -> bool

Returns true if the text of range contains any line break.

fn lines_str(&self, range: TextRange) -> &str

Returns the text of all lines that include range.

fn full_lines_str(&self, range: TextRange) -> &str

Returns the text of all lines that include range.

fn is_at_start_of_line(&self, offset: TextSize) -> bool

Returns true if offset is at the start of a line.

fn full_line_range(&self, offset: TextSize) -> TextRange

Computes the range of this offsets line.

fn line_range(&self, offset: TextSize) -> TextRange

Computes the range of this offsets line ending before the newline character.

fn full_lines_range(&self, range: TextRange) -> TextRange

Computes the range of all lines that this range covers.

fn lines_range(&self, range: TextRange) -> TextRange

Computes the range of all lines that this range covers.

fn count_lines(&self, range: TextRange) -> u32

The number of lines range spans.