Struct stencila_schema::Parameter
source · [−]pub struct Parameter {
pub type_: Parameter_,
pub name: String,
pub default: Option<Box<Node>>,
pub execute_digest: Option<Box<Cord>>,
pub id: Option<Box<String>>,
pub is_extensible: Option<Boolean>,
pub is_required: Option<Boolean>,
pub is_variadic: Option<Boolean>,
pub validator: Option<Box<ValidatorTypes>>,
pub value: Option<Box<Node>>,
}
Expand description
A parameter of a document or function.
Fields
type_: Parameter_
The name of this type
name: String
The name of the parameter.
default: Option<Box<Node>>
The default value of the parameter.
execute_digest: Option<Box<Cord>>
The SHA-256 digest of the value
property the last time the node was executed.
id: Option<Box<String>>
The identifier for this item.
is_extensible: Option<Boolean>
Indicates that this parameter is variadic and can accept multiple named arguments.
is_required: Option<Boolean>
Is this parameter required, if not it should have a default or default is assumed to be null.
is_variadic: Option<Boolean>
Indicates that this parameter is variadic and can accept multiple arguments.
validator: Option<Box<ValidatorTypes>>
The validator that the value is validated against.
value: Option<Box<Node>>
The current value of the parameter.
Trait Implementations
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
Auto Trait Implementations
impl RefUnwindSafe for Parameter
impl UnwindSafe for Parameter
Blanket Implementations
Mutably borrows from an owned value. Read more