pub struct MockBatchConfig { /* private fields */ }
Implementations§
Source§impl MockBatchConfig
impl MockBatchConfig
Sourcepub fn fails_on_attempt_1_mut(&mut self) -> &mut HashSet<String>
pub fn fails_on_attempt_1_mut(&mut self) -> &mut HashSet<String>
If a batch_id is inserted here, the mock flips it from InProgress->Failed on the first retrieval.
Sourcepub fn attempt_counters_mut(&mut self) -> &mut HashMap<String, u32>
pub fn attempt_counters_mut(&mut self) -> &mut HashMap<String, u32>
Tracks how many times we’ve retrieved a given batch_id.
Sourcepub fn planned_completions_mut(&mut self) -> &mut HashMap<String, (bool, bool)>
pub fn planned_completions_mut(&mut self) -> &mut HashMap<String, (bool, bool)>
If a batch_id is inserted here, on retrieval we flip from InProgress->Completed and set output_file_id / error_file_id accordingly. If not inserted here, we leave the batch in its existing status rather than unconditionally flipping it to Completed.
Source§impl MockBatchConfig
impl MockBatchConfig
Sourcepub fn fails_on_attempt_1(&self) -> &HashSet<String>
pub fn fails_on_attempt_1(&self) -> &HashSet<String>
If a batch_id is inserted here, the mock flips it from InProgress->Failed on the first retrieval.
Sourcepub fn attempt_counters(&self) -> &HashMap<String, u32>
pub fn attempt_counters(&self) -> &HashMap<String, u32>
Tracks how many times we’ve retrieved a given batch_id.
Sourcepub fn planned_completions(&self) -> &HashMap<String, (bool, bool)>
pub fn planned_completions(&self) -> &HashMap<String, (bool, bool)>
If a batch_id is inserted here, on retrieval we flip from InProgress->Completed and set output_file_id / error_file_id accordingly. If not inserted here, we leave the batch in its existing status rather than unconditionally flipping it to Completed.
Source§impl MockBatchConfig
impl MockBatchConfig
Sourcepub fn set_fails_on_attempt_1(
&mut self,
val: HashSet<String>,
) -> &mut MockBatchConfig
pub fn set_fails_on_attempt_1( &mut self, val: HashSet<String>, ) -> &mut MockBatchConfig
If a batch_id is inserted here, the mock flips it from InProgress->Failed on the first retrieval.
Sourcepub fn set_attempt_counters(
&mut self,
val: HashMap<String, u32>,
) -> &mut MockBatchConfig
pub fn set_attempt_counters( &mut self, val: HashMap<String, u32>, ) -> &mut MockBatchConfig
Tracks how many times we’ve retrieved a given batch_id.
Sourcepub fn set_planned_completions(
&mut self,
val: HashMap<String, (bool, bool)>,
) -> &mut MockBatchConfig
pub fn set_planned_completions( &mut self, val: HashMap<String, (bool, bool)>, ) -> &mut MockBatchConfig
If a batch_id is inserted here, on retrieval we flip from InProgress->Completed and set output_file_id / error_file_id accordingly. If not inserted here, we leave the batch in its existing status rather than unconditionally flipping it to Completed.
Trait Implementations§
Source§impl Debug for MockBatchConfig
impl Debug for MockBatchConfig
Source§impl Default for MockBatchConfig
impl Default for MockBatchConfig
Source§fn default() -> MockBatchConfig
fn default() -> MockBatchConfig
Auto Trait Implementations§
impl Freeze for MockBatchConfig
impl RefUnwindSafe for MockBatchConfig
impl Send for MockBatchConfig
impl Sync for MockBatchConfig
impl Unpin for MockBatchConfig
impl UnwindSafe for MockBatchConfig
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> 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> 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);