Struct stencila_schema::Parameter [−][src]
pub struct Parameter { pub type_: String, pub name: String, pub default: Option<Node>, pub id: Option<String>, pub is_extensible: Option<bool>, pub is_readonly: Option<bool>, pub is_required: Option<bool>, pub is_variadic: Option<bool>, pub meta: Option<BTreeMap<String, Primitive>>, pub validator: Option<ValidatorTypes>, pub value: Option<Node>, }
Expand description
A parameter that can be set and used in evaluated code.
Fields
type_: String
The name of this type
name: String
The name of the variable.
default: Option<Node>
The default value of the parameter.
id: Option<String>
The identifier for this item.
is_extensible: Option<bool>
Indicates that this parameter is variadic and can accept multiple named arguments.
is_readonly: Option<bool>
Whether or not a property is mutable. Default is false.
is_required: Option<bool>
Is this parameter required, if not it should have a default or default is assumed to be null.
is_variadic: Option<bool>
Indicates that this parameter is variadic and can accept multiple arguments.
meta: Option<BTreeMap<String, Primitive>>
Metadata associated with this item.
validator: Option<ValidatorTypes>
The validator that the value is validated against.
value: Option<Node>
The value of the variable.
Implementations
impl Parameter
[src]
impl Parameter
[src]pub fn deserialize_type<'de, D>(d: D) -> Result<String, D::Error> where
D: Deserializer<'de>,
[src]
D: Deserializer<'de>,
Trait Implementations
impl<'de> Deserialize<'de> for Parameter where
Parameter: Default,
[src]
impl<'de> Deserialize<'de> for Parameter where
Parameter: Default,
[src]fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
[src]
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
[src]Deserialize this value from the given Serde deserializer. Read more
Auto Trait Implementations
impl RefUnwindSafe for Parameter
impl Send for Parameter
impl Sync for Parameter
impl Unpin for Parameter
impl UnwindSafe for Parameter
Blanket Implementations
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]pub fn borrow_mut(&mut self) -> &mut T
[src]
pub fn borrow_mut(&mut self) -> &mut T
[src]Mutably borrows from an owned value. Read more
impl<T> ToOwned for T where
T: Clone,
[src]
impl<T> ToOwned for T where
T: Clone,
[src]type Owned = T
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn to_owned(&self) -> T
[src]Creates owned data from borrowed data, usually by cloning. Read more
pub fn clone_into(&self, target: &mut T)
[src]
pub fn clone_into(&self, target: &mut T)
[src]🔬 This is a nightly-only experimental API. (toowned_clone_into
)
recently added
Uses borrowed data to replace owned data, usually by cloning. Read more
impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,
[src]
T: for<'de> Deserialize<'de>,