#[non_exhaustive]pub struct DateTimeConverterBuilder { /* private fields */ }
Expand description
A builder for DateTimeConverter
.
Implementations§
Source§impl DateTimeConverterBuilder
impl DateTimeConverterBuilder
Sourcepub fn source(self, input: impl Into<String>) -> Self
pub fn source(self, input: impl Into<String>) -> Self
The key to apply the date conversion to.
This field is required.Sourcepub fn set_source(self, input: Option<String>) -> Self
pub fn set_source(self, input: Option<String>) -> Self
The key to apply the date conversion to.
Sourcepub fn get_source(&self) -> &Option<String>
pub fn get_source(&self) -> &Option<String>
The key to apply the date conversion to.
Sourcepub fn target(self, input: impl Into<String>) -> Self
pub fn target(self, input: impl Into<String>) -> Self
The JSON field to store the result in.
This field is required.Sourcepub fn set_target(self, input: Option<String>) -> Self
pub fn set_target(self, input: Option<String>) -> Self
The JSON field to store the result in.
Sourcepub fn get_target(&self) -> &Option<String>
pub fn get_target(&self) -> &Option<String>
The JSON field to store the result in.
Sourcepub fn target_format(self, input: impl Into<String>) -> Self
pub fn target_format(self, input: impl Into<String>) -> Self
The datetime format to use for the converted data in the target field.
If you omit this, the default of yyyy-MM-dd'T'HH:mm:ss.SSS'Z
is used.
Sourcepub fn set_target_format(self, input: Option<String>) -> Self
pub fn set_target_format(self, input: Option<String>) -> Self
The datetime format to use for the converted data in the target field.
If you omit this, the default of yyyy-MM-dd'T'HH:mm:ss.SSS'Z
is used.
Sourcepub fn get_target_format(&self) -> &Option<String>
pub fn get_target_format(&self) -> &Option<String>
The datetime format to use for the converted data in the target field.
If you omit this, the default of yyyy-MM-dd'T'HH:mm:ss.SSS'Z
is used.
Sourcepub fn match_patterns(self, input: impl Into<String>) -> Self
pub fn match_patterns(self, input: impl Into<String>) -> Self
Appends an item to match_patterns
.
To override the contents of this collection use set_match_patterns
.
A list of patterns to match against the source
field.
Sourcepub fn set_match_patterns(self, input: Option<Vec<String>>) -> Self
pub fn set_match_patterns(self, input: Option<Vec<String>>) -> Self
A list of patterns to match against the source
field.
Sourcepub fn get_match_patterns(&self) -> &Option<Vec<String>>
pub fn get_match_patterns(&self) -> &Option<Vec<String>>
A list of patterns to match against the source
field.
Sourcepub fn source_timezone(self, input: impl Into<String>) -> Self
pub fn source_timezone(self, input: impl Into<String>) -> Self
The time zone of the source field. If you omit this, the default used is the UTC zone.
Sourcepub fn set_source_timezone(self, input: Option<String>) -> Self
pub fn set_source_timezone(self, input: Option<String>) -> Self
The time zone of the source field. If you omit this, the default used is the UTC zone.
Sourcepub fn get_source_timezone(&self) -> &Option<String>
pub fn get_source_timezone(&self) -> &Option<String>
The time zone of the source field. If you omit this, the default used is the UTC zone.
Sourcepub fn target_timezone(self, input: impl Into<String>) -> Self
pub fn target_timezone(self, input: impl Into<String>) -> Self
The time zone of the target field. If you omit this, the default used is the UTC zone.
Sourcepub fn set_target_timezone(self, input: Option<String>) -> Self
pub fn set_target_timezone(self, input: Option<String>) -> Self
The time zone of the target field. If you omit this, the default used is the UTC zone.
Sourcepub fn get_target_timezone(&self) -> &Option<String>
pub fn get_target_timezone(&self) -> &Option<String>
The time zone of the target field. If you omit this, the default used is the UTC zone.
Sourcepub fn locale(self, input: impl Into<String>) -> Self
pub fn locale(self, input: impl Into<String>) -> Self
The locale of the source field. If you omit this, the default of locale.ROOT
is used.
Sourcepub fn set_locale(self, input: Option<String>) -> Self
pub fn set_locale(self, input: Option<String>) -> Self
The locale of the source field. If you omit this, the default of locale.ROOT
is used.
Sourcepub fn get_locale(&self) -> &Option<String>
pub fn get_locale(&self) -> &Option<String>
The locale of the source field. If you omit this, the default of locale.ROOT
is used.
Sourcepub fn build(self) -> Result<DateTimeConverter, BuildError>
pub fn build(self) -> Result<DateTimeConverter, BuildError>
Consumes the builder and constructs a DateTimeConverter
.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for DateTimeConverterBuilder
impl Clone for DateTimeConverterBuilder
Source§fn clone(&self) -> DateTimeConverterBuilder
fn clone(&self) -> DateTimeConverterBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for DateTimeConverterBuilder
impl Debug for DateTimeConverterBuilder
Source§impl Default for DateTimeConverterBuilder
impl Default for DateTimeConverterBuilder
Source§fn default() -> DateTimeConverterBuilder
fn default() -> DateTimeConverterBuilder
Source§impl PartialEq for DateTimeConverterBuilder
impl PartialEq for DateTimeConverterBuilder
impl StructuralPartialEq for DateTimeConverterBuilder
Auto Trait Implementations§
impl Freeze for DateTimeConverterBuilder
impl RefUnwindSafe for DateTimeConverterBuilder
impl Send for DateTimeConverterBuilder
impl Sync for DateTimeConverterBuilder
impl Unpin for DateTimeConverterBuilder
impl UnwindSafe for DateTimeConverterBuilder
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>
Returns self
with the
fg()
set to
Color::BrightBlack
.
§Example
println!("{}", value.bright_black());
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>
Returns self
with the
fg()
set to
Color::BrightGreen
.
§Example
println!("{}", value.bright_green());
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightYellow
.
§Example
println!("{}", value.bright_yellow());
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>
Returns self
with the
fg()
set to
Color::BrightMagenta
.
§Example
println!("{}", value.bright_magenta());
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>
Returns self
with the
fg()
set to
Color::BrightWhite
.
§Example
println!("{}", value.bright_white());
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>
Returns self
with the
bg()
set to
Color::BrightBlack
.
§Example
println!("{}", value.on_bright_black());
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>
Returns self
with the
bg()
set to
Color::BrightGreen
.
§Example
println!("{}", value.on_bright_green());
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightYellow
.
§Example
println!("{}", value.on_bright_yellow());
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightBlue
.
§Example
println!("{}", value.on_bright_blue());
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightMagenta
.
§Example
println!("{}", value.on_bright_magenta());
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightCyan
.
§Example
println!("{}", value.on_bright_cyan());
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightWhite
.
§Example
println!("{}", value.on_bright_white());
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 underline(&self) -> Painted<&T>
fn underline(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::Underline
.
§Example
println!("{}", value.underline());
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::RapidBlink
.
§Example
println!("{}", value.rapid_blink());
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);