Struct Files 

pub struct Files<F: 'static = BTreeMap<String, String>> { /* private fields */ }

A set of files, whose programs are written in the operations of registry: the Workspace its programs are run with, reading the programs they place and the files they import from it. A program read is checked against the operations (see Program::validate).

Each file is read once, and read again once it changes (Files::write), when its revision changes too.

Implementations

impl<F: FileStore + 'static> Files<F>

pub fn new(files: F, registry: Rc<OperationRegistry>) -> Rc<Self>

The files files, what they are made into kept in memory.

pub fn with_cache( files: F, registry: Rc<OperationRegistry>, cache: Cache, ) -> Rc<Self>

The files files, what they are made into kept in cache.

pub fn files(&self) -> Ref<'_, F>

The files, to read.

pub fn registry(&self) -> &Rc<OperationRegistry>

The operations its programs are written in.

impl<F: FileStoreMut + 'static> Files<F>

pub fn write(&self, path: &str, text: Option<String>) -> bool

Sets the file path to text, or — None — removes it, and forgets what was read from it (see Files). Says whether it changed anything: written as it was, nothing is forgotten.

Trait Implementations

impl<F: FileStore + 'static> Workspace for Files<F>

fn program(&self, path: &str) -> GeopResult<Rc<Program>>

The program in the file at path, with the state it was saved with: the same each time it is asked for while the file does not change.

fn read(&self, path: &str) -> GeopResult<Rc<str>>

The text of the file at path: a STEP file a step imports. The same each time it is asked for while the file does not change.

fn list(&self) -> Vec<String>

Every file there is, by path.

fn resolve(&self, from: &str, name: &str) -> String

The path of the file the file at from names name.

fn relative(&self, from: &str, path: &str) -> String

How the file at from names the file at path.

fn revision(&self, path: &str) -> u64

The revision of the file at path: changes whenever the file does, so a node that read it is made again.

fn cache(&self) -> Option<&Cache>

What it keeps of what its files were made into, shared by every build reading them: none, for a workspace that keeps nothing, whose files are made into what they read as each time they are read.

fn digest(&self, path: &str) -> Option<u128>

A digest of the text of the file at path as it is now: what a node that read it was made from, in any process (see crate::kept). None for a file it does not have.