#[non_exhaustive]pub struct DataValueBuilder { /* private fields */ }
Expand description
A builder for DataValue
.
Implementations§
Source§impl DataValueBuilder
impl DataValueBuilder
Sourcepub fn boolean_value(self, input: bool) -> Self
pub fn boolean_value(self, input: bool) -> Self
A Boolean value.
Sourcepub fn set_boolean_value(self, input: Option<bool>) -> Self
pub fn set_boolean_value(self, input: Option<bool>) -> Self
A Boolean value.
Sourcepub fn get_boolean_value(&self) -> &Option<bool>
pub fn get_boolean_value(&self) -> &Option<bool>
A Boolean value.
Sourcepub fn double_value(self, input: f64) -> Self
pub fn double_value(self, input: f64) -> Self
A double value.
Sourcepub fn set_double_value(self, input: Option<f64>) -> Self
pub fn set_double_value(self, input: Option<f64>) -> Self
A double value.
Sourcepub fn get_double_value(&self) -> &Option<f64>
pub fn get_double_value(&self) -> &Option<f64>
A double value.
Sourcepub fn integer_value(self, input: i32) -> Self
pub fn integer_value(self, input: i32) -> Self
An integer value.
Sourcepub fn set_integer_value(self, input: Option<i32>) -> Self
pub fn set_integer_value(self, input: Option<i32>) -> Self
An integer value.
Sourcepub fn get_integer_value(&self) -> &Option<i32>
pub fn get_integer_value(&self) -> &Option<i32>
An integer value.
Sourcepub fn long_value(self, input: i64) -> Self
pub fn long_value(self, input: i64) -> Self
A long value.
Sourcepub fn set_long_value(self, input: Option<i64>) -> Self
pub fn set_long_value(self, input: Option<i64>) -> Self
A long value.
Sourcepub fn get_long_value(&self) -> &Option<i64>
pub fn get_long_value(&self) -> &Option<i64>
A long value.
Sourcepub fn string_value(self, input: impl Into<String>) -> Self
pub fn string_value(self, input: impl Into<String>) -> Self
A string value.
Sourcepub fn set_string_value(self, input: Option<String>) -> Self
pub fn set_string_value(self, input: Option<String>) -> Self
A string value.
Sourcepub fn get_string_value(&self) -> &Option<String>
pub fn get_string_value(&self) -> &Option<String>
A string value.
Sourcepub fn list_value(self, input: DataValue) -> Self
pub fn list_value(self, input: DataValue) -> Self
Appends an item to list_value
.
To override the contents of this collection use set_list_value
.
A list of multiple values.
Sourcepub fn set_list_value(self, input: Option<Vec<DataValue>>) -> Self
pub fn set_list_value(self, input: Option<Vec<DataValue>>) -> Self
A list of multiple values.
Sourcepub fn get_list_value(&self) -> &Option<Vec<DataValue>>
pub fn get_list_value(&self) -> &Option<Vec<DataValue>>
A list of multiple values.
Sourcepub fn map_value(self, k: impl Into<String>, v: DataValue) -> Self
pub fn map_value(self, k: impl Into<String>, v: DataValue) -> Self
Adds a key-value pair to map_value
.
To override the contents of this collection use set_map_value
.
An object that maps strings to multiple DataValue
objects.
Sourcepub fn set_map_value(self, input: Option<HashMap<String, DataValue>>) -> Self
pub fn set_map_value(self, input: Option<HashMap<String, DataValue>>) -> Self
An object that maps strings to multiple DataValue
objects.
Sourcepub fn get_map_value(&self) -> &Option<HashMap<String, DataValue>>
pub fn get_map_value(&self) -> &Option<HashMap<String, DataValue>>
An object that maps strings to multiple DataValue
objects.
Sourcepub fn relationship_value(self, input: RelationshipValue) -> Self
pub fn relationship_value(self, input: RelationshipValue) -> Self
A value that relates a component to another component.
Sourcepub fn set_relationship_value(self, input: Option<RelationshipValue>) -> Self
pub fn set_relationship_value(self, input: Option<RelationshipValue>) -> Self
A value that relates a component to another component.
Sourcepub fn get_relationship_value(&self) -> &Option<RelationshipValue>
pub fn get_relationship_value(&self) -> &Option<RelationshipValue>
A value that relates a component to another component.
Sourcepub fn expression(self, input: impl Into<String>) -> Self
pub fn expression(self, input: impl Into<String>) -> Self
An expression that produces the value.
Sourcepub fn set_expression(self, input: Option<String>) -> Self
pub fn set_expression(self, input: Option<String>) -> Self
An expression that produces the value.
Sourcepub fn get_expression(&self) -> &Option<String>
pub fn get_expression(&self) -> &Option<String>
An expression that produces the value.
Trait Implementations§
Source§impl Clone for DataValueBuilder
impl Clone for DataValueBuilder
Source§fn clone(&self) -> DataValueBuilder
fn clone(&self) -> DataValueBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for DataValueBuilder
impl Debug for DataValueBuilder
Source§impl Default for DataValueBuilder
impl Default for DataValueBuilder
Source§fn default() -> DataValueBuilder
fn default() -> DataValueBuilder
Source§impl PartialEq for DataValueBuilder
impl PartialEq for DataValueBuilder
impl StructuralPartialEq for DataValueBuilder
Auto Trait Implementations§
impl Freeze for DataValueBuilder
impl RefUnwindSafe for DataValueBuilder
impl Send for DataValueBuilder
impl Sync for DataValueBuilder
impl Unpin for DataValueBuilder
impl UnwindSafe for DataValueBuilder
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);