Struct fiberplane_models::providers::CheckboxField

#[non_exhaustive]
pub struct CheckboxField {
    pub checked: bool,
    pub label: String,
    pub name: String,
    pub required: bool,
    pub value: String,
}

Defines a field that produces a boolean value.

For JSON/YAML encoding, the value will be represented as a native boolean. In the case of “application/x-www-form-urlencoded”, it will be represented by the value defined in the value field, which will be either present or not, similar to the encoding of HTML forms.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

checked: bool

Whether the checkbox should be initially checked if no query data is present.

label: String

Suggested label to display along the checkbox.

name: String

Name of the field as it will be included in the encoded query or config object.

required: bool

Whether the checkbox must be checked.

This allows for the use case of implementing Terms of Service checkboxes in config forms.

value: String

Value of the field as it will be included in the encoded query. Note that only checked checkboxes will be included.

If the data is encoded using either JSON or YAML, the checkbox state is encoded as a boolean and this value will not be used.

Implementations

impl CheckboxField

pub fn new() -> Self

Creates a new checkbox with all default values.

pub fn checked_by_default(self) -> Self

Marks the checkbox as being checked by default.

pub fn required(self) -> Self

Marks the field as required.

pub fn with_label(self, label: impl Into<String>) -> Self

pub fn with_name(self, name: impl Into<String>) -> Self

pub fn with_value(self, value: impl Into<String>) -> Self

Trait Implementations

impl Clone for CheckboxField

fn clone(&self) -> CheckboxField

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CheckboxField

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

Formats the value using the given formatter.

impl Default for CheckboxField

fn default() -> CheckboxField

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CheckboxField

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<CheckboxField> for ConfigField

fn from(field: CheckboxField) -> Self

Converts to this type from the input type.

impl From<CheckboxField> for QueryField

fn from(field: CheckboxField) -> Self

Converts to this type from the input type.

impl PartialEq for CheckboxField

fn eq(&self, other: &CheckboxField) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for CheckboxField

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for CheckboxField