Struct deno_ast::SourceTextInfo

source · [−]

pub struct SourceTextInfo { /* private fields */ }

Expand description

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

source

impl SourceTextInfo

source

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

Creates a new SourceTextInfo from the provided source text.

source

pub fn new_with_pos(start_pos: BytePos, text: Arc<String>) -> Self

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

Generally, most files will have a start position of BytePos(0) and when in doubt provide that, but SWC will not necessarily start files with BytePos(0) when bundling.

source

pub fn new_with_indent_width(
 start_pos: BytePos,
 text: Arc<String>,
 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.

source

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.

source

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

Gets the source text.

source

pub fn text_str(&self) -> &str

Gets a reference to the source text.

source

pub fn span(&self) -> Span

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

source

pub fn lines_count(&self) -> usize

Gets the number of lines in the source text.

source

pub fn line_index(&self, pos: BytePos) -> 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.

source

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

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.

source

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

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.

source

pub fn line_and_column_index(&self, pos: BytePos) -> 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.

source

pub fn line_and_column_display(&self, pos: BytePos) -> 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.

source

pub fn line_and_column_display_with_indent_width(
    &self,
    pos: BytePos,
    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.

source

pub fn byte_index(&self, line_and_column_index: LineAndColumnIndex) -> BytePos

Gets the byte 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.

source