#[non_exhaustive]pub struct FieldTypeDetailsBuilder { /* private fields */ }
Expand description
A builder for FieldTypeDetails
.
Implementations§
Source§impl FieldTypeDetailsBuilder
impl FieldTypeDetailsBuilder
Sourcepub fn field_type(self, input: impl Into<String>) -> Self
pub fn field_type(self, input: impl Into<String>) -> Self
The type of field, such as string, integer, date, and so on.
This field is required.Sourcepub fn set_field_type(self, input: Option<String>) -> Self
pub fn set_field_type(self, input: Option<String>) -> Self
The type of field, such as string, integer, date, and so on.
Sourcepub fn get_field_type(&self) -> &Option<String>
pub fn get_field_type(&self) -> &Option<String>
The type of field, such as string, integer, date, and so on.
Sourcepub fn filter_operators(self, input: Operator) -> Self
pub fn filter_operators(self, input: Operator) -> Self
Appends an item to filter_operators
.
To override the contents of this collection use set_filter_operators
.
The list of operators supported by a field.
Sourcepub fn set_filter_operators(self, input: Option<Vec<Operator>>) -> Self
pub fn set_filter_operators(self, input: Option<Vec<Operator>>) -> Self
The list of operators supported by a field.
Sourcepub fn get_filter_operators(&self) -> &Option<Vec<Operator>>
pub fn get_filter_operators(&self) -> &Option<Vec<Operator>>
The list of operators supported by a field.
Sourcepub fn supported_values(self, input: impl Into<String>) -> Self
pub fn supported_values(self, input: impl Into<String>) -> Self
Appends an item to supported_values
.
To override the contents of this collection use set_supported_values
.
The list of values that a field can contain. For example, a Boolean fieldType
can have two values: "true" and "false".
Sourcepub fn set_supported_values(self, input: Option<Vec<String>>) -> Self
pub fn set_supported_values(self, input: Option<Vec<String>>) -> Self
The list of values that a field can contain. For example, a Boolean fieldType
can have two values: "true" and "false".
Sourcepub fn get_supported_values(&self) -> &Option<Vec<String>>
pub fn get_supported_values(&self) -> &Option<Vec<String>>
The list of values that a field can contain. For example, a Boolean fieldType
can have two values: "true" and "false".
Sourcepub fn value_regex_pattern(self, input: impl Into<String>) -> Self
pub fn value_regex_pattern(self, input: impl Into<String>) -> Self
The regular expression pattern for the field name.
Sourcepub fn set_value_regex_pattern(self, input: Option<String>) -> Self
pub fn set_value_regex_pattern(self, input: Option<String>) -> Self
The regular expression pattern for the field name.
Sourcepub fn get_value_regex_pattern(&self) -> &Option<String>
pub fn get_value_regex_pattern(&self) -> &Option<String>
The regular expression pattern for the field name.
Sourcepub fn supported_date_format(self, input: impl Into<String>) -> Self
pub fn supported_date_format(self, input: impl Into<String>) -> Self
The date format that the field supports.
Sourcepub fn set_supported_date_format(self, input: Option<String>) -> Self
pub fn set_supported_date_format(self, input: Option<String>) -> Self
The date format that the field supports.
Sourcepub fn get_supported_date_format(&self) -> &Option<String>
pub fn get_supported_date_format(&self) -> &Option<String>
The date format that the field supports.
Sourcepub fn field_value_range(self, input: Range) -> Self
pub fn field_value_range(self, input: Range) -> Self
The range of values this field can hold.
Sourcepub fn set_field_value_range(self, input: Option<Range>) -> Self
pub fn set_field_value_range(self, input: Option<Range>) -> Self
The range of values this field can hold.
Sourcepub fn get_field_value_range(&self) -> &Option<Range>
pub fn get_field_value_range(&self) -> &Option<Range>
The range of values this field can hold.
Sourcepub fn field_length_range(self, input: Range) -> Self
pub fn field_length_range(self, input: Range) -> Self
This is the allowable length range for this field's value.
Sourcepub fn set_field_length_range(self, input: Option<Range>) -> Self
pub fn set_field_length_range(self, input: Option<Range>) -> Self
This is the allowable length range for this field's value.
Sourcepub fn get_field_length_range(&self) -> &Option<Range>
pub fn get_field_length_range(&self) -> &Option<Range>
This is the allowable length range for this field's value.
Sourcepub fn build(self) -> Result<FieldTypeDetails, BuildError>
pub fn build(self) -> Result<FieldTypeDetails, BuildError>
Consumes the builder and constructs a FieldTypeDetails
.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for FieldTypeDetailsBuilder
impl Clone for FieldTypeDetailsBuilder
Source§fn clone(&self) -> FieldTypeDetailsBuilder
fn clone(&self) -> FieldTypeDetailsBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for FieldTypeDetailsBuilder
impl Debug for FieldTypeDetailsBuilder
Source§impl Default for FieldTypeDetailsBuilder
impl Default for FieldTypeDetailsBuilder
Source§fn default() -> FieldTypeDetailsBuilder
fn default() -> FieldTypeDetailsBuilder
Source§impl PartialEq for FieldTypeDetailsBuilder
impl PartialEq for FieldTypeDetailsBuilder
impl StructuralPartialEq for FieldTypeDetailsBuilder
Auto Trait Implementations§
impl Freeze for FieldTypeDetailsBuilder
impl RefUnwindSafe for FieldTypeDetailsBuilder
impl Send for FieldTypeDetailsBuilder
impl Sync for FieldTypeDetailsBuilder
impl Unpin for FieldTypeDetailsBuilder
impl UnwindSafe for FieldTypeDetailsBuilder
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);