pub struct SourceTree { /* private fields */ }Expand description
The common module records and containers. These explicit facade exports keep ordinary callers out of the component crate paths. Named immutable files shared by independently selectable sources.
Construct once, then call Self::source for each primary or directory.
Views share the inventory and byte allocations. Each call creates a fresh
dependency observation set; clones of that source share its observations.
No view can acquire files outside its selected root or from the filesystem.
use std::sync::Arc;
use powerio_core::{ArtifactPath, SourceTree, SourceTreeLimits};
let limits = SourceTreeLimits::new(100, 8 << 20, 16)?;
let primary = ArtifactPath::new("masters/day.dss")?;
let tree = SourceTree::new("study", [
(primary.clone(), Arc::<[u8]>::from(&b"Redirect ../shared/lines.inc"[..])),
(ArtifactPath::new("shared/lines.inc")?, Arc::<[u8]>::from(&b"line data"[..])),
], limits)?;
let source = tree.source(None, Some(&primary), limits)?;
let master = source.primary_buffer()?;
source.referenced_buffer(&master, "../shared/lines.inc")?;
assert_eq!(source.dependencies().len(), 1);
assert!(tree.source(None, Some(&primary), limits)?.dependencies().is_empty());Implementations§
Source§impl SourceTree
impl SourceTree
Sourcepub fn new(
name: impl Into<String>,
files: impl IntoIterator<Item = (ArtifactPath, Arc<[u8]>)>,
limits: SourceTreeLimits,
) -> Result<SourceTree, Error>
pub fn new( name: impl Into<String>, files: impl IntoIterator<Item = (ArtifactPath, Arc<[u8]>)>, limits: SourceTreeLimits, ) -> Result<SourceTree, Error>
Retain unique portable paths under explicit limits. File/directory collisions are refused. Paths are case sensitive and never renamed.
Sourcepub fn source(
&self,
root: Option<&ArtifactPath>,
primary: Option<&ArtifactPath>,
limits: SourceTreeLimits,
) -> Result<Source, Error>
pub fn source( &self, root: Option<&ArtifactPath>, primary: Option<&ArtifactPath>, limits: SourceTreeLimits, ) -> Result<Source, Error>
Select a directory root and optionally a primary relative to that root.
None selects the tree root or a directory source, respectively.
All files below the root remain available as retained companions and
count against limits, including the primary. Names, source IDs, and
reference directories are rebased to that root; the primary has ID
/input. Selecting a file creates no dependency observation.
Trait Implementations§
Source§impl Clone for SourceTree
impl Clone for SourceTree
Source§fn clone(&self) -> SourceTree
fn clone(&self) -> SourceTree
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read more