Struct fiberplane_models::providers::TextField

#[non_exhaustive]
pub struct TextField {
    pub label: String,
    pub multiline: bool,
    pub multiple: bool,
    pub name: String,
    pub placeholder: String,
    pub prerequisites: Vec<String>,
    pub required: bool,
    pub supports_suggestions: bool,
}

Defines a free-form text entry field.

This is commonly used for filter text and query entry.

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.

label: String

Suggested label to display along the form field.

multiline: bool

Whether multi-line input is useful for this provider.

multiple: bool

Whether multiple values may be inserted.

name: String

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

placeholder: String

Suggested placeholder to display when there is no value.

prerequisites: Vec<String>

An optional list of fields that should be filled in before allowing the user to fill in this field. This forces a certain ordering in the data entry, which enables richer auto-suggestions, since the filled in prerequisite fields can provide additional context.

required: bool

Whether a value is required.

supports_suggestions: bool

Whether the provider supports auto-suggestions for this field.

Implementations

impl TextField

pub fn new() -> Self

Creates a new text field with all default values.

pub fn multiline(self) -> Self

Marks the field as allowing multi-line entry.

pub fn multiple(self) -> Self

Marks the field as allowing multiple values.

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

pub fn with_prerequisites(self, prerequisites: impl Into<Vec<String>>) -> Self

pub fn with_suggestions(self) -> Self

Marks the field as supporting auto-suggestions.

Trait Implementations

impl Clone for TextField

fn clone(&self) -> TextField

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TextField

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

Formats the value using the given formatter.

impl Default for TextField

fn default() -> TextField

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TextField

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<TextField> for ConfigField

fn from(field: TextField) -> Self

Converts to this type from the input type.

impl From<TextField> for QueryField

fn from(field: TextField) -> Self

Converts to this type from the input type.

impl PartialEq for TextField

fn eq(&self, other: &TextField) -> 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 TextField

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 TextField