pub struct QuantifyReturnValue<'p, F, T, O>where
F: MockFn,
T: IntoReturnOnce<F::OutputKind>,
<<F as MockFn>::OutputKind as Kind>::Return: IntoReturner<F>,{ /* private fields */ }Expand description
Builder for defining how a call pattern with an explicit return value gets verified with regards to quantification/counting.
Implementations§
Source§impl<'p, F, T, O> QuantifyReturnValue<'p, F, T, O>where
F: MockFn,
T: IntoReturnOnce<F::OutputKind>,
O: Copy,
<<F as MockFn>::OutputKind as Kind>::Return: IntoReturner<F>,
impl<'p, F, T, O> QuantifyReturnValue<'p, F, T, O>where
F: MockFn,
T: IntoReturnOnce<F::OutputKind>,
O: Copy,
<<F as MockFn>::OutputKind as Kind>::Return: IntoReturner<F>,
Sourcepub fn once(self) -> QuantifiedResponse<'p, F, O, Exact>
pub fn once(self) -> QuantifiedResponse<'p, F, O, Exact>
Expect this call pattern to be matched exactly once.
This is the only quantifier that works together with return values that don’t implement Clone.
Sourcepub fn n_times(self, times: usize) -> QuantifiedResponse<'p, F, O, Exact>
pub fn n_times(self, times: usize) -> QuantifiedResponse<'p, F, O, Exact>
Expect this call pattern to be matched exactly the specified number of times.
Sourcepub fn at_least_times(
self,
times: usize,
) -> QuantifiedResponse<'p, F, O, AtLeast>where
T: IntoReturn<F::OutputKind>,
O: Ordering<Kind = InAnyOrder>,
<<F as MockFn>::OutputKind as Kind>::Return: IntoReturner<F>,
pub fn at_least_times(
self,
times: usize,
) -> QuantifiedResponse<'p, F, O, AtLeast>where
T: IntoReturn<F::OutputKind>,
O: Ordering<Kind = InAnyOrder>,
<<F as MockFn>::OutputKind as Kind>::Return: IntoReturner<F>,
Expect this call pattern to be matched at least the specified number of times.
This only works for call patterns matched in any ordered. Strictly ordered call patterns must have exact quantification.
Trait Implementations§
impl<F, T, O> Clause for QuantifyReturnValue<'_, F, T, O>where
F: MockFn,
T: IntoReturnOnce<F::OutputKind>,
O: Copy + Ordering,
<<F as MockFn>::OutputKind as Kind>::Return: IntoReturner<F>,
Source§impl<F, T, O> Drop for QuantifyReturnValue<'_, F, T, O>where
F: MockFn,
T: IntoReturnOnce<F::OutputKind>,
<<F as MockFn>::OutputKind as Kind>::Return: IntoReturner<F>,
The drop implementation of this is intended to run when used in a stubbing clause,
when the call pattern is left unquantified by the user.
impl<F, T, O> Drop for QuantifyReturnValue<'_, F, T, O>where
F: MockFn,
T: IntoReturnOnce<F::OutputKind>,
<<F as MockFn>::OutputKind as Kind>::Return: IntoReturner<F>,
The drop implementation of this is intended to run when used in a stubbing clause, when the call pattern is left unquantified by the user.
In that case, it is only able to return once, because no Clone bound has been part of any construction step.
Auto Trait Implementations§
impl<'p, F, T, O> !RefUnwindSafe for QuantifyReturnValue<'p, F, T, O>
impl<'p, F, T, O> !UnwindSafe for QuantifyReturnValue<'p, F, T, O>
impl<'p, F, T, O> Freeze for QuantifyReturnValue<'p, F, T, O>
impl<'p, F, T, O> Send for QuantifyReturnValue<'p, F, T, O>
impl<'p, F, T, O> Sync for QuantifyReturnValue<'p, F, T, O>
impl<'p, F, T, O> Unpin for QuantifyReturnValue<'p, F, T, O>
impl<'p, F, T, O> UnsafeUnpin for QuantifyReturnValue<'p, F, T, O>where
O: UnsafeUnpin,
T: UnsafeUnpin,
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> 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>
renamed to 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);