Struct TaskDefinition 

pub struct TaskDefinition<N: TreeNode = SyntaxNode>(/* private fields */);

Represents a task definition.

Implementations

impl<N: TreeNode> TaskDefinition<N>

pub fn name(&self) -> Ident<N::Token>

Gets the name of the task.

pub fn items(&self) -> impl Iterator<Item = TaskItem<N>> + use<'_, N>

Gets the items of the task.

pub fn input(&self) -> Option<InputSection<N>>

Gets the input section of the task.

pub fn output(&self) -> Option<OutputSection<N>>

Gets the output section of the task.

pub fn command(&self) -> Option<CommandSection<N>>

Gets the command section of the task.

pub fn requirements(&self) -> Option<RequirementsSection<N>>

Gets the requirements sections of the task.

pub fn hints(&self) -> Option<TaskHintsSection<N>>

Gets the hints section of the task.

pub fn runtime(&self) -> Option<RuntimeSection<N>>

Gets the runtime section of the task.

pub fn metadata(&self) -> Option<MetadataSection<N>>

Gets the metadata section of the task.

pub fn parameter_metadata(&self) -> Option<ParameterMetadataSection<N>>

Gets the parameter section of the task.

pub fn declarations(&self) -> impl Iterator<Item = BoundDecl<N>> + use<'_, N>

Gets the private declarations of the task.

pub fn markdown_description(&self, f: &mut impl Write) -> Result

Writes a Markdown formatted description of the task.

Trait Implementations

impl<N: TreeNode> AstNode<N> for TaskDefinition<N>

fn can_cast(kind: SyntaxKind) -> bool

Determines if the kind can be cast to this representation.

fn cast(inner: N) -> Option<Self>

Casts the given inner type to the this representation.

fn inner(&self) -> &N

Gets the inner type from this representation.

fn kind(&self) -> SyntaxKind

Gets the syntax kind of the node.

fn text<'a>(&'a self) -> impl Display

where N: 'a,

Gets the text of the node.

fn span(&self) -> Span

Gets the span of the node.

fn token<C>(&self) -> Option<C>

where C: AstToken<N::Token>,

Gets the first token child that can cast to an expected type.

fn tokens<'a, C>(&'a self) -> impl Iterator<Item = C>

where C: AstToken<N::Token>, N: 'a,

Gets all the token children that can cast to an expected type.

fn last_token<C>(&self) -> Option<C>

where C: AstToken<N::Token>,

Gets the last token of the node and attempts to cast it to an expected type.

fn child<C>(&self) -> Option<C>

where C: AstNode<N>,

Gets the first node child that can cast to an expected type.

fn children<'a, C>(&'a self) -> impl Iterator<Item = C>

where C: AstNode<N>, N: 'a,

Gets all node children that can cast to an expected type.

fn parent<'a, P>(&self) -> Option<P>

where P: AstNode<N>, N: 'a,

Gets the parent of the node if the underlying tree node has a parent.

fn scope_span<O, C>(&self) -> Option<Span>

where O: AstToken<N::Token>, C: AstToken<N::Token>,

Calculates the span of a scope given the node where the scope is visible.

fn braced_scope_span(&self) -> Option<Span>

Gets the interior span of child opening and closing brace tokens for the node.

fn heredoc_scope_span(&self) -> Option<Span>

Gets the interior span of child opening and closing heredoc tokens for the node.

fn descendants<'a, D>(&'a self) -> impl Iterator<Item = D>

where D: AstNode<N>, N: 'a,

Gets the node descendants (including self) from this node that can be cast to the expected type.

impl<N: Clone + TreeNode> Clone for TaskDefinition<N>

fn clone(&self) -> TaskDefinition<N>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<N: Debug + TreeNode> Debug for TaskDefinition<N>

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

Formats the value using the given formatter.

impl<N: PartialEq + TreeNode> PartialEq for TaskDefinition<N>

fn eq(&self, other: &TaskDefinition<N>) -> 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<N: Eq + TreeNode> Eq for TaskDefinition<N>

impl<N: TreeNode> StructuralPartialEq for TaskDefinition<N>