Struct SourceFile 

pub struct SourceFile {
    pub id: SourceId,
    pub name: String,
    pub contents: Vec<u8>,
    /* private fields */
}

One loaded source file plus its line-start table.

Fields

id: SourceId

Stable identifier used by spans and diagnostics.

name: String

Logical filename used by diagnostics and include tracking.

contents: Vec<u8>

Full source bytes.

Implementations

impl SourceFile

pub fn new( id: SourceId, name: impl Into<String>, contents: impl Into<Vec<u8>>, ) -> Self

Creates a source file and precomputes line starts for span lookup.

pub fn len(&self) -> usize

Returns the byte length of the source contents.

pub fn is_empty(&self) -> bool

Returns true when the source file is empty.

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

Returns the raw source bytes.

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

Returns the source contents as UTF-8 when the file is valid UTF-8.

pub fn span_bytes(&self, span: Span) -> Option<&[u8]>

Returns the raw bytes covered by span when it belongs to this file.

pub fn span_text(&self, span: Span) -> Option<&str>

Returns the text covered by span when it belongs to this file.

pub fn location(&self, offset: usize) -> Option<SourceLocation>

Resolves a byte offset to a one-based line and column.

Trait Implementations

impl Clone for SourceFile

fn clone(&self) -> SourceFile

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SourceFile

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SourceFile

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for SourceFile

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for SourceFile

impl StructuralPartialEq for SourceFile