Struct Recipe

pub struct Recipe<'src, D = Dependency<'src>> {

    pub attributes: BTreeSet<Attribute<'src>>,
    pub body: Vec<Line<'src>>,
    pub dependencies: Vec<D>,
    pub doc: Option<String>,
    pub file_depth: u32,
    pub import_offsets: Vec<usize>,
    pub name: Name<'src>,
    pub namepath: Namepath<'src>,
    pub parameters: Vec<Parameter<'src>>,
    pub priors: usize,
    pub private: bool,
    pub quiet: bool,
    pub shebang: bool,
}

A recipe, e.g. foo: bar baz

Fields

attributes: BTreeSet<Attribute<'src>>

body: Vec<Line<'src>>

dependencies: Vec<D>

doc: Option<String>

file_depth: u32

import_offsets: Vec<usize>

name: Name<'src>

namepath: Namepath<'src>

parameters: Vec<Parameter<'src>>

priors: usize

private: bool

quiet: bool

shebang: bool

Implementations

impl<'src, D> Recipe<'src, D>

pub fn argument_range(&self) -> RangeInclusive<usize>

pub fn min_arguments(&self) -> usize

pub fn max_arguments(&self) -> usize

pub fn name(&self) -> &'src str

pub fn line_number(&self) -> usize

pub fn confirm(&self) -> RunResult<'src, bool>

pub fn check_can_be_default_recipe(&self) -> RunResult<'src, ()>

pub fn is_public(&self) -> bool

pub fn is_script(&self) -> bool

pub fn takes_positional_arguments(&self, settings: &Settings<'_>) -> bool

pub fn change_directory(&self) -> bool

pub fn enabled(&self) -> bool

pub fn run<'run>( &self, context: &ExecutionContext<'src, 'run>, scope: &Scope<'src, 'run>, positional: &[String], is_dependency: bool, ) -> RunResult<'src, ()>

pub fn run_script<'run>( &self, context: &ExecutionContext<'src, 'run>, scope: &Scope<'src, 'run>, positional: &[String], config: &Config, evaluator: Evaluator<'src, 'run>, ) -> RunResult<'src, ()>

pub fn groups(&self) -> BTreeSet<String>

pub fn doc(&self) -> Option<&str>

pub fn subsequents(&self) -> impl Iterator<Item = &D>

impl<'src> Recipe<'src, UnresolvedDependency<'src>>

pub fn resolve( self, resolved: Vec<Rc<Recipe<'src>>>, ) -> Result<Recipe<'src>, CompileError<'src>>

Trait Implementations

impl<'src, D: Clone> Clone for Recipe<'src, D>

fn clone(&self) -> Recipe<'src, D>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'src, D: Display> ColorDisplay for Recipe<'src, D>

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

fn color_display(&self, color: Color) -> Wrapper<'_>

where Self: Sized,

impl<'src, D: Debug> Debug for Recipe<'src, D>

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

Formats the value using the given formatter.

impl<'src, D> Keyed<'src> for Recipe<'src, D>

fn key(&self) -> &'src str

impl<'src, D: PartialEq> PartialEq for Recipe<'src, D>

fn eq(&self, other: &Recipe<'src, D>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'src, D> Serialize for Recipe<'src, D>

where D: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'src, D> StructuralPartialEq for Recipe<'src, D>