Struct StudyInput 

pub struct StudyInput {
    pub id: String,
    pub label: String,
    pub value: InputValue,
    pub default: InputValue,
    pub kind: InputKind,
}

An editable input, with a stable study-local id and its current value.

Fields

id: String

Id passed to Indicator::set_input.

label: String

User-facing field label.

value: InputValue

Current value.

default: InputValue

Initial value, retained when the current value is edited.

kind: InputKind

Accepted values, used to build the editor.

Implementations

impl StudyInput

pub fn new( id: impl Into<String>, label: impl Into<String>, value: InputValue, kind: InputKind, ) -> Self

Define an input for a host study.

pub fn with_default(self, value: InputValue) -> Self

Set the declared default independently of the current value.

pub fn accepts(&self, value: &InputValue) -> bool

Check a value against this input’s schema. Setters must also validate values.

Trait Implementations

impl Clone for StudyInput

fn clone(&self) -> StudyInput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StudyInput

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

Formats the value using the given formatter.