#[non_exhaustive]pub struct ExperimentConfigBuilder { /* private fields */ }
Expand description
A builder for ExperimentConfig
.
Implementations§
Source§impl ExperimentConfigBuilder
impl ExperimentConfigBuilder
Sourcepub fn experiment_name(self, input: impl Into<String>) -> Self
pub fn experiment_name(self, input: impl Into<String>) -> Self
The name of an existing experiment to associate with the trial component.
Sourcepub fn set_experiment_name(self, input: Option<String>) -> Self
pub fn set_experiment_name(self, input: Option<String>) -> Self
The name of an existing experiment to associate with the trial component.
Sourcepub fn get_experiment_name(&self) -> &Option<String>
pub fn get_experiment_name(&self) -> &Option<String>
The name of an existing experiment to associate with the trial component.
Sourcepub fn trial_name(self, input: impl Into<String>) -> Self
pub fn trial_name(self, input: impl Into<String>) -> Self
The name of an existing trial to associate the trial component with. If not specified, a new trial is created.
Sourcepub fn set_trial_name(self, input: Option<String>) -> Self
pub fn set_trial_name(self, input: Option<String>) -> Self
The name of an existing trial to associate the trial component with. If not specified, a new trial is created.
Sourcepub fn get_trial_name(&self) -> &Option<String>
pub fn get_trial_name(&self) -> &Option<String>
The name of an existing trial to associate the trial component with. If not specified, a new trial is created.
Sourcepub fn trial_component_display_name(self, input: impl Into<String>) -> Self
pub fn trial_component_display_name(self, input: impl Into<String>) -> Self
The display name for the trial component. If this key isn't specified, the display name is the trial component name.
Sourcepub fn set_trial_component_display_name(self, input: Option<String>) -> Self
pub fn set_trial_component_display_name(self, input: Option<String>) -> Self
The display name for the trial component. If this key isn't specified, the display name is the trial component name.
Sourcepub fn get_trial_component_display_name(&self) -> &Option<String>
pub fn get_trial_component_display_name(&self) -> &Option<String>
The display name for the trial component. If this key isn't specified, the display name is the trial component name.
Sourcepub fn run_name(self, input: impl Into<String>) -> Self
pub fn run_name(self, input: impl Into<String>) -> Self
The name of the experiment run to associate with the trial component.
Sourcepub fn set_run_name(self, input: Option<String>) -> Self
pub fn set_run_name(self, input: Option<String>) -> Self
The name of the experiment run to associate with the trial component.
Sourcepub fn get_run_name(&self) -> &Option<String>
pub fn get_run_name(&self) -> &Option<String>
The name of the experiment run to associate with the trial component.
Sourcepub fn build(self) -> ExperimentConfig
pub fn build(self) -> ExperimentConfig
Consumes the builder and constructs a ExperimentConfig
.
Trait Implementations§
Source§impl Clone for ExperimentConfigBuilder
impl Clone for ExperimentConfigBuilder
Source§fn clone(&self) -> ExperimentConfigBuilder
fn clone(&self) -> ExperimentConfigBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for ExperimentConfigBuilder
impl Debug for ExperimentConfigBuilder
Source§impl Default for ExperimentConfigBuilder
impl Default for ExperimentConfigBuilder
Source§fn default() -> ExperimentConfigBuilder
fn default() -> ExperimentConfigBuilder
Source§impl PartialEq for ExperimentConfigBuilder
impl PartialEq for ExperimentConfigBuilder
impl StructuralPartialEq for ExperimentConfigBuilder
Auto Trait Implementations§
impl Freeze for ExperimentConfigBuilder
impl RefUnwindSafe for ExperimentConfigBuilder
impl Send for ExperimentConfigBuilder
impl Sync for ExperimentConfigBuilder
impl Unpin for ExperimentConfigBuilder
impl UnwindSafe for ExperimentConfigBuilder
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);