Skip to main content

SourceTree

Struct SourceTree 

Source
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

Source

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.

Source

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

Source§

fn clone(&self) -> SourceTree

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for SourceTree

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<T> ByRef<T> for T

§

fn by_ref(&self) -> &T

§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T, U> Imply<T> for U
where T: ?Sized, U: ?Sized,

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V