#[non_exhaustive]pub struct DateOptionsBuilder { /* private fields */ }
Expand description
A builder for DateOptions
.
Implementations§
Source§impl DateOptionsBuilder
impl DateOptionsBuilder
Sourcepub fn default_value(self, input: impl Into<String>) -> Self
pub fn default_value(self, input: impl Into<String>) -> Self
A value to use for the field if the field isn’t specified for a document.
Sourcepub fn set_default_value(self, input: Option<String>) -> Self
pub fn set_default_value(self, input: Option<String>) -> Self
A value to use for the field if the field isn’t specified for a document.
Sourcepub fn get_default_value(&self) -> &Option<String>
pub fn get_default_value(&self) -> &Option<String>
A value to use for the field if the field isn’t specified for a document.
Sourcepub fn source_field(self, input: impl Into<String>) -> Self
pub fn source_field(self, input: impl Into<String>) -> Self
A string that represents the name of an index field. CloudSearch supports regular index fields as well as dynamic fields. A dynamic field's name defines a pattern that begins or ends with a wildcard. Any document fields that don't map to a regular index field but do match a dynamic field's pattern are configured with the dynamic field's indexing options.
Regular field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Dynamic field names must begin or end with a wildcard (*). The wildcard can also be the only character in a dynamic field name. Multiple wildcards, and wildcards embedded within a string are not supported.
The name score
is reserved and cannot be used as a field name. To reference a document's ID, you can use the name _id
.
Sourcepub fn set_source_field(self, input: Option<String>) -> Self
pub fn set_source_field(self, input: Option<String>) -> Self
A string that represents the name of an index field. CloudSearch supports regular index fields as well as dynamic fields. A dynamic field's name defines a pattern that begins or ends with a wildcard. Any document fields that don't map to a regular index field but do match a dynamic field's pattern are configured with the dynamic field's indexing options.
Regular field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Dynamic field names must begin or end with a wildcard (*). The wildcard can also be the only character in a dynamic field name. Multiple wildcards, and wildcards embedded within a string are not supported.
The name score
is reserved and cannot be used as a field name. To reference a document's ID, you can use the name _id
.
Sourcepub fn get_source_field(&self) -> &Option<String>
pub fn get_source_field(&self) -> &Option<String>
A string that represents the name of an index field. CloudSearch supports regular index fields as well as dynamic fields. A dynamic field's name defines a pattern that begins or ends with a wildcard. Any document fields that don't map to a regular index field but do match a dynamic field's pattern are configured with the dynamic field's indexing options.
Regular field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Dynamic field names must begin or end with a wildcard (*). The wildcard can also be the only character in a dynamic field name. Multiple wildcards, and wildcards embedded within a string are not supported.
The name score
is reserved and cannot be used as a field name. To reference a document's ID, you can use the name _id
.
Sourcepub fn facet_enabled(self, input: bool) -> Self
pub fn facet_enabled(self, input: bool) -> Self
Whether facet information can be returned for the field.
Sourcepub fn set_facet_enabled(self, input: Option<bool>) -> Self
pub fn set_facet_enabled(self, input: Option<bool>) -> Self
Whether facet information can be returned for the field.
Sourcepub fn get_facet_enabled(&self) -> &Option<bool>
pub fn get_facet_enabled(&self) -> &Option<bool>
Whether facet information can be returned for the field.
Sourcepub fn search_enabled(self, input: bool) -> Self
pub fn search_enabled(self, input: bool) -> Self
Whether the contents of the field are searchable.
Sourcepub fn set_search_enabled(self, input: Option<bool>) -> Self
pub fn set_search_enabled(self, input: Option<bool>) -> Self
Whether the contents of the field are searchable.
Sourcepub fn get_search_enabled(&self) -> &Option<bool>
pub fn get_search_enabled(&self) -> &Option<bool>
Whether the contents of the field are searchable.
Sourcepub fn return_enabled(self, input: bool) -> Self
pub fn return_enabled(self, input: bool) -> Self
Whether the contents of the field can be returned in the search results.
Sourcepub fn set_return_enabled(self, input: Option<bool>) -> Self
pub fn set_return_enabled(self, input: Option<bool>) -> Self
Whether the contents of the field can be returned in the search results.
Sourcepub fn get_return_enabled(&self) -> &Option<bool>
pub fn get_return_enabled(&self) -> &Option<bool>
Whether the contents of the field can be returned in the search results.
Sourcepub fn sort_enabled(self, input: bool) -> Self
pub fn sort_enabled(self, input: bool) -> Self
Whether the field can be used to sort the search results.
Sourcepub fn set_sort_enabled(self, input: Option<bool>) -> Self
pub fn set_sort_enabled(self, input: Option<bool>) -> Self
Whether the field can be used to sort the search results.
Sourcepub fn get_sort_enabled(&self) -> &Option<bool>
pub fn get_sort_enabled(&self) -> &Option<bool>
Whether the field can be used to sort the search results.
Sourcepub fn build(self) -> DateOptions
pub fn build(self) -> DateOptions
Consumes the builder and constructs a DateOptions
.
Trait Implementations§
Source§impl Clone for DateOptionsBuilder
impl Clone for DateOptionsBuilder
Source§fn clone(&self) -> DateOptionsBuilder
fn clone(&self) -> DateOptionsBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for DateOptionsBuilder
impl Debug for DateOptionsBuilder
Source§impl Default for DateOptionsBuilder
impl Default for DateOptionsBuilder
Source§fn default() -> DateOptionsBuilder
fn default() -> DateOptionsBuilder
Source§impl PartialEq for DateOptionsBuilder
impl PartialEq for DateOptionsBuilder
impl StructuralPartialEq for DateOptionsBuilder
Auto Trait Implementations§
impl Freeze for DateOptionsBuilder
impl RefUnwindSafe for DateOptionsBuilder
impl Send for DateOptionsBuilder
impl Sync for DateOptionsBuilder
impl Unpin for DateOptionsBuilder
impl UnwindSafe for DateOptionsBuilder
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);