Struct SourceDocument 

pub struct SourceDocument { /* private fields */ }

Immutable source content retained by a compilation.

Implementations

impl SourceDocument

pub fn id(&self) -> SourceId

Return this document’s compilation-local identity.

pub fn origin(&self) -> &SourceOrigin

Return this document’s stable physical or logical origin.

pub fn label(&self) -> &str

Return the display label used for this document.

pub fn bytes(&self) -> &[u8]

Return the immutable source bytes.

pub fn len(&self) -> ByteOffset

Return the source length as a validated compiler byte offset.

pub fn is_empty(&self) -> bool

Return whether this document contains no bytes.

pub fn line_count(&self) -> usize

Return the number of logical lines.

Every document has at least one line. A trailing LF, CRLF, or lone CR creates a final empty line.

pub fn offset(&self, offset: usize) -> Result<ByteOffset, SourceRangeError>

Validate and convert a byte index into a compiler byte offset.

The exclusive end-of-document offset is valid.

pub fn range( &self, range: Range<usize>, ) -> Result<SourceRange, SourceRangeError>

Create a checked half-open byte range in this document.

pub fn empty_range( &self, offset: usize, ) -> Result<SourceRange, SourceRangeError>

Create a checked empty range at a byte offset in this document.

pub fn slice(&self, range: SourceRange) -> Result<&[u8], SourceRangeError>

Return the bytes covered by a checked source range.

pub fn line_column( &self, offset: ByteOffset, ) -> Result<(usize, usize), SourceRangeError>

Convert a checked byte offset to a one-based line and byte column.

The exclusive end-of-document offset is valid. Columns count bytes; callers needing editor character encodings must convert explicitly.

pub fn byte_position( &self, offset: ByteOffset, ) -> Result<BytePosition, PositionError>

Convert a byte offset to a zero-based byte position.

Every offset from zero through EOF is representable, including offsets on either byte of CRLF and offsets inside invalid UTF-8.

pub fn byte_offset( &self, position: BytePosition, ) -> Result<ByteOffset, PositionError>

Convert a zero-based byte position to its byte offset.

On non-final lines, positions identify every terminator byte. The offset immediately after an LF, CRLF, or lone CR is column zero of the next line. On the final line, its end position identifies EOF.

pub fn position( &self, offset: ByteOffset, encoding: PositionEncoding, ) -> Result<Position, PositionError>

Convert a byte offset to an editor position in an explicit encoding.

The source must be valid UTF-8, and the offset must lie on a Unicode scalar boundary. Line terminators are excluded from editor columns. The start of LF, CRLF, or lone CR maps to the line’s end position; the offset between CR and LF has no editor-position representation.

pub fn position_offset( &self, position: Position, encoding: PositionEncoding, ) -> Result<ByteOffset, PositionError>

Convert an editor position in an explicit encoding to a byte offset.

Lines and characters are zero-based. End-of-line positions map to the first byte of LF, CRLF, or lone CR; a trailing terminator creates a final empty line whose zero position maps to EOF.

Trait Implementations

impl Debug for SourceDocument

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

Formats the value using the given formatter.