pub struct Expect<T> { /* private fields */ }Expand description
The main Expect wrapper for fluent assertions
Implementations§
Source§impl Expect<bool>
impl Expect<bool>
Sourcepub fn to_be_true(&self)
pub fn to_be_true(&self)
Sourcepub fn to_be_false(&self)
pub fn to_be_false(&self)
Source§impl<T: Debug> Expect<Option<T>>
impl<T: Debug> Expect<Option<T>>
Sourcepub fn to_be_some(&self)
pub fn to_be_some(&self)
Sourcepub fn to_be_none(&self)
pub fn to_be_none(&self)
Source§impl<T: Debug + PartialEq> Expect<Option<T>>
impl<T: Debug + PartialEq> Expect<Option<T>>
Sourcepub fn to_contain_value(&self, expected: T)
pub fn to_contain_value(&self, expected: T)
Source§impl Expect<String>
impl Expect<String>
Sourcepub fn to_contain(&self, substring: &str)
pub fn to_contain(&self, substring: &str)
Sourcepub fn to_start_with(&self, prefix: &str)
pub fn to_start_with(&self, prefix: &str)
Sourcepub fn to_end_with(&self, suffix: &str)
pub fn to_end_with(&self, suffix: &str)
Sourcepub fn to_have_length(&self, expected: usize)
pub fn to_have_length(&self, expected: usize)
Sourcepub fn to_be_empty(&self)
pub fn to_be_empty(&self)
Source§impl Expect<&str>
impl Expect<&str>
Sourcepub fn to_contain(&self, substring: &str)
pub fn to_contain(&self, substring: &str)
Assert that the string contains the substring
Sourcepub fn to_start_with(&self, prefix: &str)
pub fn to_start_with(&self, prefix: &str)
Assert that the string starts with the prefix
Sourcepub fn to_end_with(&self, suffix: &str)
pub fn to_end_with(&self, suffix: &str)
Assert that the string ends with the suffix
Sourcepub fn to_have_length(&self, expected: usize)
pub fn to_have_length(&self, expected: usize)
Assert that the string has the expected length
Sourcepub fn to_be_empty(&self)
pub fn to_be_empty(&self)
Assert that the string is empty
Source§impl<T: Debug + PartialEq> Expect<Vec<T>>
impl<T: Debug + PartialEq> Expect<Vec<T>>
Sourcepub fn to_have_length(&self, expected: usize)
pub fn to_have_length(&self, expected: usize)
Sourcepub fn to_contain(&self, item: &T)
pub fn to_contain(&self, item: &T)
Sourcepub fn to_be_empty(&self)
pub fn to_be_empty(&self)
Source§impl<T: Debug + PartialOrd> Expect<T>
impl<T: Debug + PartialOrd> Expect<T>
Sourcepub fn to_be_greater_than(&self, expected: T)
pub fn to_be_greater_than(&self, expected: T)
Sourcepub fn to_be_less_than(&self, expected: T)
pub fn to_be_less_than(&self, expected: T)
Sourcepub fn to_be_greater_than_or_equal(&self, expected: T)
pub fn to_be_greater_than_or_equal(&self, expected: T)
Sourcepub fn to_be_less_than_or_equal(&self, expected: T)
pub fn to_be_less_than_or_equal(&self, expected: T)
Auto Trait Implementations§
impl<T> Freeze for Expect<T>where
T: Freeze,
impl<T> RefUnwindSafe for Expect<T>where
T: RefUnwindSafe,
impl<T> Send for Expect<T>where
T: Send,
impl<T> Sync for Expect<T>where
T: Sync,
impl<T> Unpin for Expect<T>where
T: Unpin,
impl<T> UnsafeUnpin for Expect<T>where
T: UnsafeUnpin,
impl<T> UnwindSafe for Expect<T>where
T: UnwindSafe,
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> 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>
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);