Skip to main content

Workspace

Struct Workspace 

Source
pub struct Workspace { /* private fields */ }
Expand description

An isolated, throwaway working copy of an authoring project template.

Created by Workspace::stage; the working copy lives under a temporary directory that is removed when the Workspace is dropped. The submitted source is written into, and the build runs entirely within, Workspace::root — never the template.

Implementations§

Source§

impl Workspace

Source

pub fn stage(template_root: &Path) -> Result<Self, ToolchainError>

Stages a fresh, isolated working copy of template_root.

Creates a temporary directory as a sibling of template_root (under its parent) and recursively copies the template’s contents directly into it, so the working-copy root sits at the same directory depth as the template. Same-depth sibling placement preserves the template’s relative path dependencies (aion_flow and any other source = "local" Gleam dependency): a path such as ../../gleam/aion_flow resolves identically from the working copy as from the template root.

The template is read only — it is never written to or built in. The returned Workspace owns the temporary directory and removes it on drop.

§Errors

Returns ToolchainError::InvalidProject when template_root has no parent directory (a filesystem root cannot host a sibling), and ToolchainError::Io when the sibling temporary directory cannot be created (for example the template’s parent directory is not writable) or the recursive copy fails.

Source

pub fn root(&self) -> &Path

The isolated working-copy project root: where the submitted source is written and the build runs. It is the temporary directory itself — a same-depth sibling of the template.

Trait Implementations§

Source§

impl Debug for Workspace

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

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
Source§

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

Source§

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

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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.

Source§

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, 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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more