Struct FSProvider 

pub struct FSProvider { /* private fields */ }

provider that loads declerations from the file system.

this provider syncronously loads decleration files from the file system, and caches them for future use.

this provider works only in a specifed root directory, and loads files of any extension.

it can fails safely when loading.

example

let provider = FSProvider::new("/path/to/decls").unwrap();

// cache common files
provider.load_file("commons.stomd").unwrap();

// loads other.stomd, commons.stomd is cached
parse(
	"import \"commons.stomd\" import \"other.stomd\" ... ",
	&ParseOptions::default(), &provider
).unwrap();

// fails in loading not_found.stomd
assert!(parse("import \"not_found.stomd\" ... ", &ParseOptions::default(), &provider).is_err() == true);

Implementations

impl FSProvider

pub fn new(root: impl Into<PathBuf>) -> Result<Self>

creates a FSProvider working on a given root directory with default options.

pub fn with_options( root: impl Into<PathBuf>, parse_options: ParseOptions, ) -> Result<Self>

creates a FSProvider working on a given root directory with given options.

pub fn load_file<'a>( &'a self, path: impl AsRef<Path>, ) -> Result<&'a DeclFile, LoadFileError>

load a declaration file at a given path.

returns a reference to the cached file if used before, else load it and returns LoadFileError if an error occurs.

Trait Implementations

impl Debug for FSProvider

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

Formats the value using the given formatter.

impl DeclProvider for FSProvider

fn get_by_name<'a>(&'a self, name: &str) -> Option<&'a DeclFile>

gets a decleration file with a given name.

load it if not loaded before, returns None if not found or can not be parsed.

fn get_by_id(&self, id: u64) -> &DeclFile

get a decleration file by its id.