Struct Documents 

pub struct Documents { /* private fields */ }

documents: a filtered, read-only view over a fixed set of named text documents.

Granting documents never grants filesystem access. A host names exactly which documents exist; there is no way to reach a path this module was not built to expose, so a grant of documents is narrow authority, never ambient access to a directory.

Implementations

impl Documents

pub fn in_memory(documents: BTreeMap<String, String>) -> Self

A fake implementation backed by an in-memory map, for tests.

pub fn rooted(root: PathBuf) -> Self

Reads <root>/<name>.txt for a document named name.

name must be a single plain path component: empty names, ., .., and names containing /, \, or a NUL byte are all rejected before the filesystem is touched. This keeps the capability narrow: a grant of documents can only ever reach the fixed set of .txt files under root, never an arbitrary path via traversal or an absolute path.

Trait Implementations

impl HostApi for Documents

fn module_schema(&self) -> ModuleSchema

The whole of what this module declares about itself: the name Cove source uses, the capability a host must grant for it, the operations it exposes, the types it declares, and the kinds of resource it can open.

fn call(&self, op: &str, args: Vec<Value>) -> Result<Value, RuntimeError>

Invokes one operation.

fn call_with( &self, op: &str, args: Vec<Value>, back: &mut dyn Reentry, ) -> Result<Value, RuntimeError>

Invokes one operation.

fn call_resource( &self, handle: &ResourceHandle, op: &str, args: Vec<Value>, back: &mut dyn Reentry, ) -> Result<Value, RuntimeError>

Invokes one operation on a handle this module issued.