Struct Layout 

pub struct Layout { /* private fields */ }

The session’s workspace: the one coordinate, and the model of the files in it. Construction proves what every user needs: the directory exists (canonical), and is one line of text — it crosses into bash. Handed to every reaction at construction, since the instrument’s own frames name a file in here.

Implementations

impl Layout

pub fn path(&self) -> &Path

The workspace: the session’s address.

pub fn text(&self) -> &str

The workspace as text — what a rig splices into its bash, spelled through bash_strings::emit_scalar.

pub fn bash_env( &self, provision: Provision<'_>, ) -> Result<(OsString, OsString), Failure>

The one owner of <dir>/bash_env.bash: writes it — the two sources, then the joining line iff provisioned — and yields the ("BASH_ENV", <file>) pair. Every non-interactive bash in the tree the subject creates sources that file as it starts; whether that initiates the channel is provision, stated by the caller. The core consults neither this pair nor any other: a run’s environment is whatever its closure returns.

Trait Implementations

impl Clone for Layout

fn clone(&self) -> Layout

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Layout

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

Formats the value using the given formatter.