1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80
#[cfg(feature = "fp-bindgen")]
use fp_bindgen::prelude::Serializable;
use serde::{Deserialize, Serialize};
/// 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.
#[derive(Clone, Debug, Default, Deserialize, Serialize, PartialEq)]
#[cfg_attr(
feature = "fp-bindgen",
derive(Serializable),
fp(rust_module = "fiberplane_models::providers")
)]
#[non_exhaustive]
#[serde(rename_all = "camelCase")]
pub struct LabelField {
/// Name of the field as it will be included in the encoded query or config
/// object.
pub name: String,
/// Suggested label to display along the field (not to be confused with
/// labels to be selected).
pub label: String,
/// Whether multiple labels may be selected.
pub multiple: bool,
/// Suggested placeholder to display when there is no value.
pub placeholder: String,
/// Whether a value is required.
pub required: bool,
}
impl LabelField {
/// Creates a new label field with all default values.
pub fn new() -> Self {
Default::default()
}
/// Marks the field as allowing multiple labels to be selected.
pub fn multiple(self) -> Self {
Self {
multiple: true,
..self
}
}
/// Marks the field as required.
pub fn required(self) -> Self {
Self {
required: true,
..self
}
}
pub fn with_label(self, label: impl Into<String>) -> Self {
Self {
label: label.into(),
..self
}
}
pub fn with_name(self, name: impl Into<String>) -> Self {
Self {
name: name.into(),
..self
}
}
pub fn with_placeholder(self, placeholder: impl Into<String>) -> Self {
Self {
placeholder: placeholder.into(),
..self
}
}
}