Struct SourceTextInfo

pub struct SourceTextInfo { /* private fields */ }

Stores the source text along with other data such as where all the lines occur in the text.

Note: This struct is cheap to clone.

Implementations

impl SourceTextInfo

pub fn new(text: Arc<str>) -> Self

Creates a new SourceTextInfo from the provided source text.

pub fn new_with_pos(start_pos: SourcePos, text: Arc<str>) -> Self

Creates a new SourceTextInfo from the provided source start position and source text.

Note: When bundling swc will keep increasing the start position for each source file.

pub fn new_with_indent_width( start_pos: SourcePos, text: Arc<str>, indent_width: usize, ) -> Self

Creates a new SourceTextInfo from the provided start position, source text, and indentation width.

The indentation width determines the number of columns to use when going over a tab character. For example, an indent width of 2 will mean each tab character will represent 2 columns. The default indentation width used in the other methods is 2 to match the default indentation used by deno fmt.

pub fn from_string(text: String) -> Self

Creates a new SourceTextInfo from the provided source text.

Generally, prefer using SourceTextInfo::new to provide a string already in an std::sync::Arc.

pub fn as_string_input(&self) -> StringInput<'_>

Gets an swc StringInput for this text information that can be used with parsing.

pub fn text(&self) -> Arc<str>

Gets the source text.

pub fn text_str(&self) -> &str

Gets a reference to the source text.

pub fn range(&self) -> SourceRange<StartSourcePos>

Gets the range—start and end byte position—of the source text.

pub fn lines_count(&self) -> usize

Gets the number of lines in the source text.

pub fn line_index(&self, pos: SourcePos) -> usize

Gets the 0-indexed line index at the provided byte position.

Note that this will panic when providing a byte position outside the range of the source text.

pub fn line_start(&self, line_index: usize) -> SourcePos

Gets the line start byte position of the provided 0-indexed line index.

Note that this will panic if providing a line index outside the bounds of the number of lines.

pub fn line_end(&self, line_index: usize) -> SourcePos

Gets the line end byte position of the provided 0-indexed line index.

Note that this will panic if providing a line index outside the bounds of the number of lines.

pub fn line_and_column_index(&self, pos: SourcePos) -> LineAndColumnIndex

Gets the 0-indexed line and column index of the provided byte position.

Note that this will panic when providing a byte position outside the range of the source text.

pub fn line_and_column_display(&self, pos: SourcePos) -> LineAndColumnDisplay

Gets the 1-indexed line and column index of the provided byte position taking into account the default indentation width.

Note that this will panic when providing a byte position outside the range of the source text.

pub fn line_and_column_display_with_indent_width( &self, pos: SourcePos, indent_width: usize, ) -> LineAndColumnDisplay

Gets the 1-indexed line and column index of the provided byte position with a custom indentation width.

Note that this will panic when providing a byte position outside the range of the source text.

pub fn loc_to_source_pos( &self, line_and_column_index: LineAndColumnIndex, ) -> SourcePos

Gets the source position of the provided line and column index.

Note that this will panic if providing a line index outside the bounds of the number of lines, but will clip the the line end byte index when exceeding the line length.

pub fn line_text(&self, line_index: usize) -> &str

Gets a reference to the text slice of the line at the provided 0-based index.

Note that this will panic if providing a line index outside the bounds of the number of lines.

pub fn range_text(&self, range: &SourceRange) -> &str

Gets the source text located within the provided range.

Trait Implementations

impl Clone for SourceTextInfo

fn clone(&self) -> SourceTextInfo

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SourceTextInfo

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

Formats the value using the given formatter.

impl<'a> SourceTextInfoProvider<'a> for &'a SourceTextInfo

fn text_info(&self) -> &'a SourceTextInfo