#[non_exhaustive]pub struct FieldInputConfigBuilder { /* private fields */ }
Expand description
A builder for FieldInputConfig
.
Implementations§
Source§impl FieldInputConfigBuilder
impl FieldInputConfigBuilder
Sourcepub fn type(self, input: impl Into<String>) -> Self
pub fn type(self, input: impl Into<String>) -> Self
The input type for the field.
This field is required.Sourcepub fn set_required(self, input: Option<bool>) -> Self
pub fn set_required(self, input: Option<bool>) -> Self
Specifies a field that requires input.
Sourcepub fn get_required(&self) -> &Option<bool>
pub fn get_required(&self) -> &Option<bool>
Specifies a field that requires input.
Sourcepub fn set_read_only(self, input: Option<bool>) -> Self
pub fn set_read_only(self, input: Option<bool>) -> Self
Specifies a read only field.
Sourcepub fn get_read_only(&self) -> &Option<bool>
pub fn get_read_only(&self) -> &Option<bool>
Specifies a read only field.
Sourcepub fn placeholder(self, input: impl Into<String>) -> Self
pub fn placeholder(self, input: impl Into<String>) -> Self
The text to display as a placeholder for the field.
Sourcepub fn set_placeholder(self, input: Option<String>) -> Self
pub fn set_placeholder(self, input: Option<String>) -> Self
The text to display as a placeholder for the field.
Sourcepub fn get_placeholder(&self) -> &Option<String>
pub fn get_placeholder(&self) -> &Option<String>
The text to display as a placeholder for the field.
Sourcepub fn default_value(self, input: impl Into<String>) -> Self
pub fn default_value(self, input: impl Into<String>) -> Self
The default value for the field.
Sourcepub fn set_default_value(self, input: Option<String>) -> Self
pub fn set_default_value(self, input: Option<String>) -> Self
The default value for the field.
Sourcepub fn get_default_value(&self) -> &Option<String>
pub fn get_default_value(&self) -> &Option<String>
The default value for the field.
Sourcepub fn descriptive_text(self, input: impl Into<String>) -> Self
pub fn descriptive_text(self, input: impl Into<String>) -> Self
The text to display to describe the field.
Sourcepub fn set_descriptive_text(self, input: Option<String>) -> Self
pub fn set_descriptive_text(self, input: Option<String>) -> Self
The text to display to describe the field.
Sourcepub fn get_descriptive_text(&self) -> &Option<String>
pub fn get_descriptive_text(&self) -> &Option<String>
The text to display to describe the field.
Sourcepub fn default_checked(self, input: bool) -> Self
pub fn default_checked(self, input: bool) -> Self
Specifies whether a field has a default value.
Sourcepub fn set_default_checked(self, input: Option<bool>) -> Self
pub fn set_default_checked(self, input: Option<bool>) -> Self
Specifies whether a field has a default value.
Sourcepub fn get_default_checked(&self) -> &Option<bool>
pub fn get_default_checked(&self) -> &Option<bool>
Specifies whether a field has a default value.
Sourcepub fn default_country_code(self, input: impl Into<String>) -> Self
pub fn default_country_code(self, input: impl Into<String>) -> Self
The default country code for a phone number.
Sourcepub fn set_default_country_code(self, input: Option<String>) -> Self
pub fn set_default_country_code(self, input: Option<String>) -> Self
The default country code for a phone number.
Sourcepub fn get_default_country_code(&self) -> &Option<String>
pub fn get_default_country_code(&self) -> &Option<String>
The default country code for a phone number.
Sourcepub fn value_mappings(self, input: ValueMappings) -> Self
pub fn value_mappings(self, input: ValueMappings) -> Self
The information to use to customize the input fields with data at runtime.
Sourcepub fn set_value_mappings(self, input: Option<ValueMappings>) -> Self
pub fn set_value_mappings(self, input: Option<ValueMappings>) -> Self
The information to use to customize the input fields with data at runtime.
Sourcepub fn get_value_mappings(&self) -> &Option<ValueMappings>
pub fn get_value_mappings(&self) -> &Option<ValueMappings>
The information to use to customize the input fields with data at runtime.
Sourcepub fn set_min_value(self, input: Option<f32>) -> Self
pub fn set_min_value(self, input: Option<f32>) -> Self
The minimum value to display for the field.
Sourcepub fn get_min_value(&self) -> &Option<f32>
pub fn get_min_value(&self) -> &Option<f32>
The minimum value to display for the field.
Sourcepub fn set_max_value(self, input: Option<f32>) -> Self
pub fn set_max_value(self, input: Option<f32>) -> Self
The maximum value to display for the field.
Sourcepub fn get_max_value(&self) -> &Option<f32>
pub fn get_max_value(&self) -> &Option<f32>
The maximum value to display for the field.
Sourcepub fn set_step(self, input: Option<f32>) -> Self
pub fn set_step(self, input: Option<f32>) -> Self
The stepping increment for a numeric value in a field.
Sourcepub fn is_array(self, input: bool) -> Self
pub fn is_array(self, input: bool) -> Self
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 set_is_array(self, input: Option<bool>) -> Self
pub fn set_is_array(self, input: Option<bool>) -> Self
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 get_is_array(&self) -> &Option<bool>
pub fn get_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, input: FileUploaderFieldConfig) -> Self
pub fn file_uploader_config(self, input: FileUploaderFieldConfig) -> Self
The configuration for the file uploader field.
Sourcepub fn set_file_uploader_config(
self,
input: Option<FileUploaderFieldConfig>,
) -> Self
pub fn set_file_uploader_config( self, input: Option<FileUploaderFieldConfig>, ) -> Self
The configuration for the file uploader field.
Sourcepub fn get_file_uploader_config(&self) -> &Option<FileUploaderFieldConfig>
pub fn get_file_uploader_config(&self) -> &Option<FileUploaderFieldConfig>
The configuration for the file uploader field.
Sourcepub fn build(self) -> Result<FieldInputConfig, BuildError>
pub fn build(self) -> Result<FieldInputConfig, BuildError>
Consumes the builder and constructs a FieldInputConfig
.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for FieldInputConfigBuilder
impl Clone for FieldInputConfigBuilder
Source§fn clone(&self) -> FieldInputConfigBuilder
fn clone(&self) -> FieldInputConfigBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for FieldInputConfigBuilder
impl Debug for FieldInputConfigBuilder
Source§impl Default for FieldInputConfigBuilder
impl Default for FieldInputConfigBuilder
Source§fn default() -> FieldInputConfigBuilder
fn default() -> FieldInputConfigBuilder
Source§impl PartialEq for FieldInputConfigBuilder
impl PartialEq for FieldInputConfigBuilder
impl StructuralPartialEq for FieldInputConfigBuilder
Auto Trait Implementations§
impl Freeze for FieldInputConfigBuilder
impl RefUnwindSafe for FieldInputConfigBuilder
impl Send for FieldInputConfigBuilder
impl Sync for FieldInputConfigBuilder
impl Unpin for FieldInputConfigBuilder
impl UnwindSafe for FieldInputConfigBuilder
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);