Struct Definition 

pub struct Definition {
    pub kind: VariableType,
    pub default: Option<Value>,
    pub allowed: Option<Vec<Value>>,
    pub description: Option<String>,
    pub required: bool,
    pub pattern: Option<String>,
    pub max_length: Option<u32>,
}

Fields

kind: VariableType

The value’s type. Dates are real calendar dates in YYYY-MM-DD form.

default: Option<Value>

Used when no project, folder, report, Set, schedule or CLI value supplies this variable.

allowed: Option<Vec<Value>>

Optional exact values accepted for this variable; required for the enum type.

description: Option<String>

What this input means, including its units or reporting period.

required: bool

Whether execution requires a value. A default satisfies this requirement.

pattern: Option<String>

For string variables: a regular expression the whole value must match, e.g. ^[A-Z]{3}[0-9]{4}$ for a customer code. Anchors are implied.

max_length: Option<u32>

For string variables: the most characters a value may have.

Implementations

impl Definition

pub fn problems(&self, name: &str) -> Vec<String>

Problems with the declaration itself: pattern/max_length on a non-string, or a pattern that isn’t a valid regular expression.

pub fn check(&self, name: &str, value: &Value) -> Result<(), String>

Trait Implementations

impl Clone for Definition

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Definition

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Definition

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for Definition

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Serialize for Definition

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.