Skip to main content

TaskProgram

Struct TaskProgram 

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

A task program whose modules are loaded, ready to run.

Implementations§

Source§

impl TaskProgram

Source

pub fn load(task: TaskInfo, print: &dyn PrintSink) -> ProgramLoad

Parse the task block and load every module it loads, directly or indirectly.

A load path is relative to the loading file, or absolute. Each module is evaluated once per task, outside the task, with print output going to print.

Source

pub fn load_noting( task: TaskInfo, print: &dyn PrintSink, noting: bool, ) -> ProgramLoad

Load the task program as TaskProgram::load does; when noting is set, also note how each module read and each file access ended, in ProgramLoad::outcomes and then in TaskRun::outcomes of its run, for the observation report of kizz run --output.

Source

pub const fn hash(&self) -> ProgramHash

The hash of the block and every module it loads.

Source

pub const fn parts(&self) -> &ProgramParts

The hashes of the block and of each module it loads, so explanations can name the part that changed.

Source

pub const fn task(&self) -> &TaskInfo

The task.

Source

pub fn run( self, caller: &BTreeMap<String, String>, executor: &dyn StepExecutor, print: &dyn PrintSink, ) -> TaskRun

Evaluate the task block, handing each run() call to executor in program order, with print output going to print.

The task environment starts empty. caller is the caller environment, the only one that env.caller and env.inherit read. The result holds every file access the program made while it ran, and every file it changed, whether or not it failed, and every step it left unchecked: when the program ends, whether it succeeded or failed, each step that exited with a non-zero code or was killed by a signal, whose run() had no expect, and whose result’s rc and signal the program never read.

Trait Implementations§

Source§

impl Debug for TaskProgram

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
§

impl<T> AsTypeStaticRegistered for T

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<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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

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

§

impl<T> Instrument for T

§

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

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

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

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

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
§

impl<T> StarlarkAnyBound for T
where T: Debug + Send + Sync + 'static,

§

impl<T> ToAst for T

§

fn ast(self, begin: usize, end: usize) -> Spanned<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.
§

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

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

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