Struct TaskFile 

pub struct TaskFile { /* private fields */ }

A parsed task file: the jobs, any file-level environment hoisted to all of them (an Env: under a section heading applies to every job regardless of where in the document it appears; hoisting is not positional), and any parse warnings (an unterminated fence, a duplicate job, an unknown fence language). Parsing is infallible. A malformed file still yields what it can, so an embedder should surface warnings() rather than trust silence. The internal fields carry execution mechanics; a consumer reaches jobs through jobs and job, and runs them through run, run_captured, or run_agent.

Implementations

impl TaskFile

pub fn jobs(&self) -> &[Job]

The jobs in this file, in document order.

pub fn job(&self, name: &str) -> Option<&Job>

Find a job by name. The match is exact and case-sensitive, against the heading text as written. The first definition wins if a name is duplicated (a warning is recorded).

pub fn warnings(&self) -> &[String]

Any parse warnings (an unterminated fence, a duplicate job, an unknown fence language). Parsing is infallible, so surface these rather than trust silence.

Trait Implementations

impl Clone for TaskFile

fn clone(&self) -> TaskFile

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TaskFile

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

Formats the value using the given formatter.

impl Default for TaskFile

fn default() -> TaskFile

Returns the “default value” for a type.

impl Eq for TaskFile

impl PartialEq for TaskFile

fn eq(&self, other: &TaskFile) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for TaskFile