Struct Parameter 

pub struct Parameter {
    pub id: Identifier,
    pub specified_type: Option<TypeAnnotation>,
    pub default_value: Option<Expression>,
    pub src_ref: SrcRef,
}

A parameter of a parameter list.

Fields

id: Identifier

Name of the parameter

specified_type: Option<TypeAnnotation>

Type of the parameter or None

default_value: Option<Expression>

default value of the parameter or None

src_ref: SrcRef

Source code reference

Implementations

impl Parameter

pub fn new( id: Identifier, specified_type: Option<TypeAnnotation>, default_value: Option<Expression>, src_ref: SrcRef, ) -> Self

Create new parameter

pub fn no_ref(id: &str, ty: Type) -> Self

Create a new parameter without any SrcRef’s

pub fn eval_default_value(&self, context: &mut EvalContext) -> EvalResult<Value>

Evaluate default value considering specified type

If there is no default value, returns Value::None without raising an error.

Trait Implementations

impl Clone for Parameter

fn clone(&self) -> Parameter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Parameter

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

Formats the value using the given formatter.

impl Default for Parameter

fn default() -> Parameter

Returns the “default value” for a type.

impl Display for Parameter

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

Formats the value using the given formatter.

impl Eval<ParameterValue> for Parameter

fn eval(&self, context: &mut EvalContext) -> EvalResult<ParameterValue>

Evaluate Parameter into ParameterValue.

impl From<&Parameter> for ParameterInfo

fn from(param: &Parameter) -> Self

Converts to this type from the input type.

impl OrdMapValue<Identifier> for Parameter

fn key(&self) -> Option<Identifier>

return some unique key of this value or None

impl Parse for Parameter

Short cut to create a ParameterList instance

fn parse(pair: Pair<'_>) -> ParseResult<Self>

impl SrcReferrer for Parameter

fn src_ref(&self) -> SrcRef

Return source code reference.

fn source_hash(&self) -> u64

Return source code hash.

impl TreeDisplay for Parameter

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

Write item into f and use {:depth$} syntax in front of your single line output to get proper indention.

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

Display as tree starting at depth 0.

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

Display as tree starting at given depth in debug mode

fn write_tree(&self, f: &mut impl Write) -> Result<()>

Display as tree starting at depth 0 into a file