Struct LabelField 

#[non_exhaustive]
pub struct LabelField {
    pub name: String,
    pub label: String,
    pub multiple: bool,
    pub placeholder: String,
    pub required: bool,
}

Defines a field that allows labels to be selected.

For JSON/YAML encoding, the value will be represented as a string or an array of strings, depending on the value of the multiple field. In the case of “application/x-www-form-urlencoded”, the value is always a single string and multiple labels will be space-separated.

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.

name: String

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

label: String

Suggested label to display along the field (not to be confused with labels to be selected).

multiple: bool

Whether multiple labels may be selected.

placeholder: String

Suggested placeholder to display when there is no value.

required: bool

Whether a value is required.

Implementations

impl LabelField

pub fn new() -> Self

Creates a new label field with all default values.

pub fn multiple(self) -> Self

Marks the field as allowing multiple labels to be selected.

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_placeholder(self, placeholder: impl Into<String>) -> Self

Trait Implementations

impl Clone for LabelField

fn clone(&self) -> LabelField

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LabelField

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

Formats the value using the given formatter.

impl Default for LabelField

fn default() -> LabelField

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for LabelField

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<LabelField> for QueryField

fn from(field: LabelField) -> Self

Converts to this type from the input type.

impl PartialEq for LabelField

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for LabelField

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 LabelField