#[non_exhaustive]pub struct FieldInputConfig {Show 16 fields
pub type: String,
pub required: Option<bool>,
pub read_only: Option<bool>,
pub placeholder: Option<String>,
pub default_value: Option<String>,
pub descriptive_text: Option<String>,
pub default_checked: Option<bool>,
pub default_country_code: Option<String>,
pub value_mappings: Option<ValueMappings>,
pub name: Option<String>,
pub min_value: Option<f32>,
pub max_value: Option<f32>,
pub step: Option<f32>,
pub value: Option<String>,
pub is_array: Option<bool>,
pub file_uploader_config: Option<FileUploaderFieldConfig>,
}
Expand description
Describes the configuration for the default input values to display for a field.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.type: String
The input type for the field.
required: Option<bool>
Specifies a field that requires input.
read_only: Option<bool>
Specifies a read only field.
placeholder: Option<String>
The text to display as a placeholder for the field.
default_value: Option<String>
The default value for the field.
descriptive_text: Option<String>
The text to display to describe the field.
default_checked: Option<bool>
Specifies whether a field has a default value.
default_country_code: Option<String>
The default country code for a phone number.
value_mappings: Option<ValueMappings>
The information to use to customize the input fields with data at runtime.
name: Option<String>
The name of the field.
min_value: Option<f32>
The minimum value to display for the field.
max_value: Option<f32>
The maximum value to display for the field.
step: Option<f32>
The stepping increment for a numeric value in a field.
value: Option<String>
The value for the field.
is_array: Option<bool>
Specifies whether to render the field as an array. This property is ignored if the dataSourceType
for the form is a Data Store.
file_uploader_config: Option<FileUploaderFieldConfig>
The configuration for the file uploader field.
Implementations§
Source§impl FieldInputConfig
impl FieldInputConfig
Sourcepub fn placeholder(&self) -> Option<&str>
pub fn placeholder(&self) -> Option<&str>
The text to display as a placeholder for the field.
Sourcepub fn default_value(&self) -> Option<&str>
pub fn default_value(&self) -> Option<&str>
The default value for the field.
Sourcepub fn descriptive_text(&self) -> Option<&str>
pub fn descriptive_text(&self) -> Option<&str>
The text to display to describe the field.
Sourcepub fn default_checked(&self) -> Option<bool>
pub fn default_checked(&self) -> Option<bool>
Specifies whether a field has a default value.
Sourcepub fn default_country_code(&self) -> Option<&str>
pub fn default_country_code(&self) -> Option<&str>
The default country code for a phone number.
Sourcepub fn value_mappings(&self) -> Option<&ValueMappings>
pub fn value_mappings(&self) -> Option<&ValueMappings>
The information to use to customize the input fields with data at runtime.
Sourcepub fn is_array(&self) -> Option<bool>
pub fn is_array(&self) -> Option<bool>
Specifies whether to render the field as an array. This property is ignored if the dataSourceType
for the form is a Data Store.
Sourcepub fn file_uploader_config(&self) -> Option<&FileUploaderFieldConfig>
pub fn file_uploader_config(&self) -> Option<&FileUploaderFieldConfig>
The configuration for the file uploader field.
Source§impl FieldInputConfig
impl FieldInputConfig
Sourcepub fn builder() -> FieldInputConfigBuilder
pub fn builder() -> FieldInputConfigBuilder
Creates a new builder-style object to manufacture FieldInputConfig
.
Trait Implementations§
Source§impl Clone for FieldInputConfig
impl Clone for FieldInputConfig
Source§fn clone(&self) -> FieldInputConfig
fn clone(&self) -> FieldInputConfig
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for FieldInputConfig
impl Debug for FieldInputConfig
Source§impl PartialEq for FieldInputConfig
impl PartialEq for FieldInputConfig
impl StructuralPartialEq for FieldInputConfig
Auto Trait Implementations§
impl Freeze for FieldInputConfig
impl RefUnwindSafe for FieldInputConfig
impl Send for FieldInputConfig
impl Sync for FieldInputConfig
impl Unpin for FieldInputConfig
impl UnwindSafe for FieldInputConfig
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);