Struct Parameter

pub struct Parameter { /* private fields */ }

A parameter (input or output) in a workflow or task.

Implementations

impl Parameter

pub fn new(decl: Decl, meta: Option<MetadataValue>, io: InputOutput) -> Self

Create a new parameter.

pub fn name(&self) -> String

Get the name of the parameter.

pub fn ty(&self) -> String

Get the type of the parameter.

pub fn io(&self) -> InputOutput

Get whether the parameter is an input or output.

pub fn expr(&self) -> String

Get the Expr value of the parameter as a String.

pub fn required(&self) -> Option<bool>

Get whether the input parameter is required.

Returns None for outputs.

pub fn group(&self) -> Option<Group>

Get the “group” of the parameter.

pub fn description(&self) -> Markup

Get the description of the parameter.

pub fn render_remaining_meta(&self) -> Markup

Render the remaining metadata as HTML.

This will render any metadata that is not rendered elsewhere.

pub fn render(&self) -> Markup

Render the parameter as HTML.

Trait Implementations

impl Debug for Parameter

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

Formats the value using the given formatter.