Struct Source

pub struct Source {
    pub contents: String,
    pub path: PathBuf,
}

Source represents some literal source code. Whether a repl session, a file on disk, or some library code. It’s essentially a string with a path, the path serving as the source’s name. Source files without a path point to ./source, though this behaviour might change in the future.

Fields

contents: String

path: PathBuf

Implementations

impl Source

pub fn new(source: &str, path: &Path) -> Rc<Source>

Creates a new Source given both an &str and a PathBuf. Note that this function does not check that the contents of the file match the source. Source::path or Source::source should be used instead.

pub fn path(path: &Path) -> Result<Rc<Source>>

Build a Source from a path. This will read a file to create a new source.

pub fn source(source: &str) -> Rc<Source>

Build an empty Source containing just a string. Note that this source will point towards ./source.

Trait Implementations

impl Debug for Source

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

Formats the value using the given formatter.

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