Struct SourceFile 

pub struct SourceFile { /* private fields */ }

A SourceFile represents a single file stored in a super::SourceManager

Implementations

impl SourceFile

pub fn new( id: SourceId, lang: SourceLanguage, uri: Uri, content: impl Into<Box<str>>, ) -> SourceFile

Create a new SourceFile from its raw components

pub fn from_raw_parts(id: SourceId, content: SourceContent) -> SourceFile

This function is intended for use by super::SourceManager implementations that need to construct a SourceFile from its raw components (i.e. the identifier for the source file and its content).

Since the only entity that should be constructing a [SourceId] is a super::SourceManager, it is only valid to call this function in one of two scenarios:

1. You are a super::SourceManager constructing a SourceFile after allocating a [SourceId]
2. You pass [SourceId::default()], i.e. [SourceId::UNKNOWN] for the source identifier. The resulting SourceFile will be valid and safe to use in a context where there isn’t a super::SourceManager present. If there is a source manager in use, then constructing detached SourceFiles is not recommended, because it will make it confusing to determine whether a given SourceFile reference is safe to use.

You should rarely, if ever, fall in camp 2 - but it can be handy in some narrow cases

pub const fn id(&self) -> SourceId

Get the [SourceId] associated with this file

pub fn uri(&self) -> &Uri

Get the name of this source file

pub fn content(&self) -> &SourceContent

Returns a reference to the underlying [SourceContent]

pub fn content_mut(&mut self) -> &mut SourceContent

Returns a mutable reference to the underlying [SourceContent]

pub fn line_count(&self) -> usize

Returns the number of lines in this file

pub fn len(&self) -> usize

Returns the number of bytes in this file

pub fn is_empty(&self) -> bool

Returns true if this file is empty

pub fn as_str(&self) -> &str

Get the underlying content of this file

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

Get the underlying content of this file as a byte slice

pub fn source_span(&self) -> SourceSpan

Returns a [SourceSpan] covering the entirety of this file

pub fn source_slice(&self, span: impl Into<Range<usize>>) -> Option<&str>

Returns a subset of the underlying content as a string slice.

The bounds of the given span are byte indices, not character indices.

Returns None if the given span is out of bounds, or if the bounds do not fall on valid UTF-8 character boundaries.

pub fn slice( self: &Arc<SourceFile>, span: impl Into<Range<u32>>, ) -> SourceFileRef

Returns a [SourceFileRef] corresponding to the bytes contained in the specified span.

pub fn line_column_to_span( &self, line: LineNumber, column: ColumnNumber, ) -> Option<SourceSpan>

Get a [SourceSpan] which points to the first byte of the character at column on line

Returns None if the given line/column is out of bounds for this file.

pub fn location(&self, span: SourceSpan) -> FileLineCol

Get a [FileLineCol] equivalent to the start of the given [SourceSpan]

Trait Implementations

impl AsRef<[u8]> for SourceFile

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<str> for SourceFile

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

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<(), Error>

Formats the value using the given formatter.

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

fn deserialize<__D>( __deserializer: __D, ) -> Result<SourceFile, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for SourceFile

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for SourceFile

fn cmp(&self, other: &SourceFile) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

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 PartialOrd for SourceFile

fn partial_cmp(&self, other: &SourceFile) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for SourceFile

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl SourceCode for SourceFile

fn read_span<'a>( &'a self, span: &SourceSpan, context_lines_before: usize, context_lines_after: usize, ) -> Result<Box<dyn SpanContents<'a> + 'a>, MietteError>

Read the bytes for a specific span from this SourceCode, keeping a certain number of lines before and after the span as context.

impl Eq for SourceFile

impl StructuralPartialEq for SourceFile