Struct Source 

pub struct Source {
    pub doc: Option<DocBlock>,
    pub name: QualifiedName,
    pub statements: StatementList,
    pub url: Url,
    pub source: Hashed<String>,
    pub line_offset: u32,
}

µcad source file

Fields

doc: Option<DocBlock>

Documentation.

name: QualifiedName

Qualified name of the file if loaded from externals

statements: StatementList

Root code body.

url: Url

Name of loaded file.

source: Hashed<String>

Source file string with hash

line_offset: u32

Line offset

Implementations

impl Source

pub fn new( doc: Option<DocBlock>, statements: StatementList, source: Hashed<String>, url: Url, ) -> Self

Create new source file from existing source.

pub fn with_line_offset(self, line_offset: u32) -> Self

pub fn id(&self) -> Identifier

Return the module name from the file name

pub fn filename(&self) -> PathBuf

Return filename of loaded file or <NO FILE>

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

Return filename of loaded file or <NO FILE>

pub fn get_code(&self, src_ref: &SrcRef) -> &str

get a specific line

• line: line number beginning at 0

pub fn set_name(&mut self, name: QualifiedName)

Set file name.

pub fn source_loc_info<'a>(&'a self) -> SourceLocInfo<'a>

Get a miette source adapter for the SourceFile

impl Source

pub fn from_source(source: &Source) -> Result<Rc<Self>, LowerError>

pub fn load( path: impl AsRef<Path> + Debug, ) -> Result<Rc<Self>, LowerErrorsWithSource>

Load µcad source file from given path

pub fn load_with_name( path: impl AsRef<Path> + Debug, name: QualifiedName, ) -> (Rc<Self>, Option<LowerErrorsWithSource>)

Load µcad source file from given path

pub fn load_from_str( name: Option<&str>, path: impl AsRef<Path>, source_str: &str, ) -> Result<Rc<Self>, Vec<LowerError>>

Create SourceFile from string The hash of the result will be of crate::from_str!().

pub fn name_from_path(path: impl AsRef<Path>) -> QualifiedName

Get the source file name from path.

impl Source

pub fn symbolize( &self, visibility: Visibility, context: &mut ResolveContext, ) -> ResolveResult<Symbol>

Create symbol from definition.

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

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

Formats the value using the given formatter.

impl Doc for Source

fn inner_doc(&self) -> DocBlock

Fetch inner documentation.

fn doc(&self) -> DocBlock

Return block of documentation.

fn outer_doc(&self) -> DocBlock

Fetch outer documentation.

impl Lower for Source

type AstNode = Program

fn lower( node: &Self::AstNode, context: &LowerContext<'_>, ) -> Result<Self, LowerError>

impl ResourceLocation for Source

fn url(&self) -> &Url

The canonical identity of the resource.

fn to_file_path(&self) -> Option<PathBuf>

Attempts to convert the location to a physical filesystem path. Returns None if the resource is virtual (e.g., ucad-std:// or snippet://).

fn is_local(&self) -> bool

Helper to identify if the resource exists on disk.

fn relative_path(&self) -> Option<PathBuf>

Return the relative file path from current directory.

fn source_name(&self) -> String

The source name

impl SrcReferrer for Source

fn src_ref(&self) -> SrcRef

Return source code reference.

fn source_hash(&self) -> u64

Return source code hash.