#[non_exhaustive]pub struct ParametersBuilder { /* private fields */ }
Expand description
A builder for Parameters
.
Implementations§
Source§impl ParametersBuilder
impl ParametersBuilder
Sourcepub fn string_parameters(self, input: StringParameter) -> Self
pub fn string_parameters(self, input: StringParameter) -> Self
Appends an item to string_parameters
.
To override the contents of this collection use set_string_parameters
.
The parameters that have a data type of string.
Sourcepub fn set_string_parameters(self, input: Option<Vec<StringParameter>>) -> Self
pub fn set_string_parameters(self, input: Option<Vec<StringParameter>>) -> Self
The parameters that have a data type of string.
Sourcepub fn get_string_parameters(&self) -> &Option<Vec<StringParameter>>
pub fn get_string_parameters(&self) -> &Option<Vec<StringParameter>>
The parameters that have a data type of string.
Sourcepub fn integer_parameters(self, input: IntegerParameter) -> Self
pub fn integer_parameters(self, input: IntegerParameter) -> Self
Appends an item to integer_parameters
.
To override the contents of this collection use set_integer_parameters
.
The parameters that have a data type of integer.
Sourcepub fn set_integer_parameters(
self,
input: Option<Vec<IntegerParameter>>,
) -> Self
pub fn set_integer_parameters( self, input: Option<Vec<IntegerParameter>>, ) -> Self
The parameters that have a data type of integer.
Sourcepub fn get_integer_parameters(&self) -> &Option<Vec<IntegerParameter>>
pub fn get_integer_parameters(&self) -> &Option<Vec<IntegerParameter>>
The parameters that have a data type of integer.
Sourcepub fn decimal_parameters(self, input: DecimalParameter) -> Self
pub fn decimal_parameters(self, input: DecimalParameter) -> Self
Appends an item to decimal_parameters
.
To override the contents of this collection use set_decimal_parameters
.
The parameters that have a data type of decimal.
Sourcepub fn set_decimal_parameters(
self,
input: Option<Vec<DecimalParameter>>,
) -> Self
pub fn set_decimal_parameters( self, input: Option<Vec<DecimalParameter>>, ) -> Self
The parameters that have a data type of decimal.
Sourcepub fn get_decimal_parameters(&self) -> &Option<Vec<DecimalParameter>>
pub fn get_decimal_parameters(&self) -> &Option<Vec<DecimalParameter>>
The parameters that have a data type of decimal.
Sourcepub fn date_time_parameters(self, input: DateTimeParameter) -> Self
pub fn date_time_parameters(self, input: DateTimeParameter) -> Self
Appends an item to date_time_parameters
.
To override the contents of this collection use set_date_time_parameters
.
The parameters that have a data type of date-time.
Sourcepub fn set_date_time_parameters(
self,
input: Option<Vec<DateTimeParameter>>,
) -> Self
pub fn set_date_time_parameters( self, input: Option<Vec<DateTimeParameter>>, ) -> Self
The parameters that have a data type of date-time.
Sourcepub fn get_date_time_parameters(&self) -> &Option<Vec<DateTimeParameter>>
pub fn get_date_time_parameters(&self) -> &Option<Vec<DateTimeParameter>>
The parameters that have a data type of date-time.
Sourcepub fn build(self) -> Parameters
pub fn build(self) -> Parameters
Consumes the builder and constructs a Parameters
.
Trait Implementations§
Source§impl Clone for ParametersBuilder
impl Clone for ParametersBuilder
Source§fn clone(&self) -> ParametersBuilder
fn clone(&self) -> ParametersBuilder
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for ParametersBuilder
impl Debug for ParametersBuilder
Source§impl Default for ParametersBuilder
impl Default for ParametersBuilder
Source§fn default() -> ParametersBuilder
fn default() -> ParametersBuilder
Source§impl PartialEq for ParametersBuilder
impl PartialEq for ParametersBuilder
impl StructuralPartialEq for ParametersBuilder
Auto Trait Implementations§
impl Freeze for ParametersBuilder
impl RefUnwindSafe for ParametersBuilder
impl Send for ParametersBuilder
impl Sync for ParametersBuilder
impl Unpin for ParametersBuilder
impl UnwindSafe for ParametersBuilder
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);