#[non_exhaustive]pub struct DatumBuilder { /* private fields */ }
Expand description
A builder for Datum
.
Implementations§
Source§impl DatumBuilder
impl DatumBuilder
Sourcepub fn scalar_value(self, input: impl Into<String>) -> Self
pub fn scalar_value(self, input: impl Into<String>) -> Self
Indicates if the data point is a scalar value such as integer, string, double, or Boolean.
Sourcepub fn set_scalar_value(self, input: Option<String>) -> Self
pub fn set_scalar_value(self, input: Option<String>) -> Self
Indicates if the data point is a scalar value such as integer, string, double, or Boolean.
Sourcepub fn get_scalar_value(&self) -> &Option<String>
pub fn get_scalar_value(&self) -> &Option<String>
Indicates if the data point is a scalar value such as integer, string, double, or Boolean.
Sourcepub fn time_series_value(self, input: TimeSeriesDataPoint) -> Self
pub fn time_series_value(self, input: TimeSeriesDataPoint) -> Self
Appends an item to time_series_value
.
To override the contents of this collection use set_time_series_value
.
Indicates if the data point is a timeseries data type.
Sourcepub fn set_time_series_value(
self,
input: Option<Vec<TimeSeriesDataPoint>>,
) -> Self
pub fn set_time_series_value( self, input: Option<Vec<TimeSeriesDataPoint>>, ) -> Self
Indicates if the data point is a timeseries data type.
Sourcepub fn get_time_series_value(&self) -> &Option<Vec<TimeSeriesDataPoint>>
pub fn get_time_series_value(&self) -> &Option<Vec<TimeSeriesDataPoint>>
Indicates if the data point is a timeseries data type.
Sourcepub fn array_value(self, input: Datum) -> Self
pub fn array_value(self, input: Datum) -> Self
Appends an item to array_value
.
To override the contents of this collection use set_array_value
.
Indicates if the data point is an array.
Sourcepub fn set_array_value(self, input: Option<Vec<Datum>>) -> Self
pub fn set_array_value(self, input: Option<Vec<Datum>>) -> Self
Indicates if the data point is an array.
Sourcepub fn get_array_value(&self) -> &Option<Vec<Datum>>
pub fn get_array_value(&self) -> &Option<Vec<Datum>>
Indicates if the data point is an array.
Sourcepub fn set_row_value(self, input: Option<Row>) -> Self
pub fn set_row_value(self, input: Option<Row>) -> Self
Indicates if the data point is a row.
Sourcepub fn get_row_value(&self) -> &Option<Row>
pub fn get_row_value(&self) -> &Option<Row>
Indicates if the data point is a row.
Sourcepub fn null_value(self, input: bool) -> Self
pub fn null_value(self, input: bool) -> Self
Indicates if the data point is null.
Sourcepub fn set_null_value(self, input: Option<bool>) -> Self
pub fn set_null_value(self, input: Option<bool>) -> Self
Indicates if the data point is null.
Sourcepub fn get_null_value(&self) -> &Option<bool>
pub fn get_null_value(&self) -> &Option<bool>
Indicates if the data point is null.
Trait Implementations§
Source§impl Clone for DatumBuilder
impl Clone for DatumBuilder
Source§fn clone(&self) -> DatumBuilder
fn clone(&self) -> DatumBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for DatumBuilder
impl Debug for DatumBuilder
Source§impl Default for DatumBuilder
impl Default for DatumBuilder
Source§fn default() -> DatumBuilder
fn default() -> DatumBuilder
Source§impl PartialEq for DatumBuilder
impl PartialEq for DatumBuilder
impl StructuralPartialEq for DatumBuilder
Auto Trait Implementations§
impl Freeze for DatumBuilder
impl RefUnwindSafe for DatumBuilder
impl Send for DatumBuilder
impl Sync for DatumBuilder
impl Unpin for DatumBuilder
impl UnwindSafe for DatumBuilder
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);