Skip to main content

StepCtx

Struct StepCtx 

Source
pub struct StepCtx<'a, P>
where P: ProcessManager,
{ /* private fields */ }
Expand description

Per-step execution context handed to every command handler.

Host-registered functions receive this context: read script state through the public accessors (get_var, get_env, cwd) and return a Value. The fields stay crate-private so execution invariants hold for hosts.

Output contract (load-bearing for LET-capture, pipes, and stream assertions): handlers must emit stdout/stderr ONLY through out/err — via write_stdout or StreamHandle::to_stdout/to_stderr — and never write to host stdout directly. The step runner swaps these handles per context: LET $x: STRING = <command> installs a spillable capture sink, WITH_IO installs named-pipe endpoints, and the root installs the assertion tee. A handler that bypasses its context handles silently breaks all three.

Implementations§

Source§

impl<'a, P> StepCtx<'a, P>
where P: ProcessManager,

Source

pub fn get_var(&self, key: &str) -> Option<Value>

Look up a script variable by name (innermost scope first).

Source

pub fn get_env(&self, key: &str) -> Option<String>

Look up an environment variable visible to the script.

Source

pub fn cwd(&self) -> &GuardedPath

Current working directory (guarded; stays inside the workspace).

Auto Trait Implementations§

§

impl<'a, P> !RefUnwindSafe for StepCtx<'a, P>

§

impl<'a, P> !Sync for StepCtx<'a, P>

§

impl<'a, P> !UnwindSafe for StepCtx<'a, P>

§

impl<'a, P> Freeze for StepCtx<'a, P>
where &'a mut ExecState<P>: Freeze, &'a mut P: Freeze,

§

impl<'a, P> Send for StepCtx<'a, P>
where &'a mut ExecState<P>: Send, &'a mut P: Send,

§

impl<'a, P> Unpin for StepCtx<'a, P>
where &'a mut ExecState<P>: Unpin, &'a mut P: Unpin,

§

impl<'a, P> UnsafeUnpin for StepCtx<'a, P>

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