Struct Source 

pub struct Source { /* private fields */ }

Represents source text that can be indexed into to define individual Spans.

Implementations

impl Source

pub fn source_text(&self) -> IndexedSlice<'_>

Returns the underlying text of this Source, with original formatting.

pub fn from_str(string: impl AsRef<str>) -> Self

Creates a new Source from a string.

pub fn from_indexed_string(text: IndexedString) -> Self

Creates a new Source from an IndexedString.

pub fn from_file(path: impl AsRef<Path>) -> Result<Self, Error>

Reads the contents of a file and returns a Source with the file’s text.

Since no parsing is done at this stage, only IO or encoding errors will be returned, regardless of the validity of the syntax in the file.

pub fn set_path(&mut self, path: Option<impl AsRef<Path>>)

Sets the path of the file that this Source was read from.

pub fn source_path(&self) -> Option<&Path>

Returns the path of the file that this Source was read from, if it was read from a file.

Trait Implementations

impl Clone for Source

fn clone(&self) -> Source

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Source

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

Formats the value using the given formatter.

impl Deref for Source

type Target = IndexedString

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<S: ToString> From<S> for Source

fn from(value: S) -> Self

Converts to this type from the input type.

impl Hash for Source

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

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 PartialEq for Source

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

impl StructuralPartialEq for Source