#[non_exhaustive]pub struct SuiteBuilder { /* private fields */ }
Expand description
A builder for Suite
.
Implementations§
Source§impl SuiteBuilder
impl SuiteBuilder
Sourcepub fn type(self, input: TestType) -> Self
pub fn type(self, input: TestType) -> Self
The suite's type.
Must be one of the following values:
-
BUILTIN_FUZZ
-
APPIUM_JAVA_JUNIT
-
APPIUM_JAVA_TESTNG
-
APPIUM_PYTHON
-
APPIUM_NODE
-
APPIUM_RUBY
-
APPIUM_WEB_JAVA_JUNIT
-
APPIUM_WEB_JAVA_TESTNG
-
APPIUM_WEB_PYTHON
-
APPIUM_WEB_NODE
-
APPIUM_WEB_RUBY
-
INSTRUMENTATION
-
XCTEST
-
XCTEST_UI
Sourcepub fn set_type(self, input: Option<TestType>) -> Self
pub fn set_type(self, input: Option<TestType>) -> Self
The suite's type.
Must be one of the following values:
-
BUILTIN_FUZZ
-
APPIUM_JAVA_JUNIT
-
APPIUM_JAVA_TESTNG
-
APPIUM_PYTHON
-
APPIUM_NODE
-
APPIUM_RUBY
-
APPIUM_WEB_JAVA_JUNIT
-
APPIUM_WEB_JAVA_TESTNG
-
APPIUM_WEB_PYTHON
-
APPIUM_WEB_NODE
-
APPIUM_WEB_RUBY
-
INSTRUMENTATION
-
XCTEST
-
XCTEST_UI
Sourcepub fn get_type(&self) -> &Option<TestType>
pub fn get_type(&self) -> &Option<TestType>
The suite's type.
Must be one of the following values:
-
BUILTIN_FUZZ
-
APPIUM_JAVA_JUNIT
-
APPIUM_JAVA_TESTNG
-
APPIUM_PYTHON
-
APPIUM_NODE
-
APPIUM_RUBY
-
APPIUM_WEB_JAVA_JUNIT
-
APPIUM_WEB_JAVA_TESTNG
-
APPIUM_WEB_PYTHON
-
APPIUM_WEB_NODE
-
APPIUM_WEB_RUBY
-
INSTRUMENTATION
-
XCTEST
-
XCTEST_UI
Sourcepub fn set_created(self, input: Option<DateTime>) -> Self
pub fn set_created(self, input: Option<DateTime>) -> Self
When the suite was created.
Sourcepub fn get_created(&self) -> &Option<DateTime>
pub fn get_created(&self) -> &Option<DateTime>
When the suite was created.
Sourcepub fn status(self, input: ExecutionStatus) -> Self
pub fn status(self, input: ExecutionStatus) -> Self
The suite's status.
Allowed values include:
-
PENDING
-
PENDING_CONCURRENCY
-
PENDING_DEVICE
-
PROCESSING
-
SCHEDULING
-
PREPARING
-
RUNNING
-
COMPLETED
-
STOPPING
Sourcepub fn set_status(self, input: Option<ExecutionStatus>) -> Self
pub fn set_status(self, input: Option<ExecutionStatus>) -> Self
The suite's status.
Allowed values include:
-
PENDING
-
PENDING_CONCURRENCY
-
PENDING_DEVICE
-
PROCESSING
-
SCHEDULING
-
PREPARING
-
RUNNING
-
COMPLETED
-
STOPPING
Sourcepub fn get_status(&self) -> &Option<ExecutionStatus>
pub fn get_status(&self) -> &Option<ExecutionStatus>
The suite's status.
Allowed values include:
-
PENDING
-
PENDING_CONCURRENCY
-
PENDING_DEVICE
-
PROCESSING
-
SCHEDULING
-
PREPARING
-
RUNNING
-
COMPLETED
-
STOPPING
Sourcepub fn result(self, input: ExecutionResult) -> Self
pub fn result(self, input: ExecutionResult) -> Self
The suite's result.
Allowed values include:
-
PENDING
-
PASSED
-
WARNED
-
FAILED
-
SKIPPED
-
ERRORED
-
STOPPED
Sourcepub fn set_result(self, input: Option<ExecutionResult>) -> Self
pub fn set_result(self, input: Option<ExecutionResult>) -> Self
The suite's result.
Allowed values include:
-
PENDING
-
PASSED
-
WARNED
-
FAILED
-
SKIPPED
-
ERRORED
-
STOPPED
Sourcepub fn get_result(&self) -> &Option<ExecutionResult>
pub fn get_result(&self) -> &Option<ExecutionResult>
The suite's result.
Allowed values include:
-
PENDING
-
PASSED
-
WARNED
-
FAILED
-
SKIPPED
-
ERRORED
-
STOPPED
Sourcepub fn set_started(self, input: Option<DateTime>) -> Self
pub fn set_started(self, input: Option<DateTime>) -> Self
The suite's start time.
Sourcepub fn get_started(&self) -> &Option<DateTime>
pub fn get_started(&self) -> &Option<DateTime>
The suite's start time.
Sourcepub fn set_stopped(self, input: Option<DateTime>) -> Self
pub fn set_stopped(self, input: Option<DateTime>) -> Self
The suite's stop time.
Sourcepub fn get_stopped(&self) -> &Option<DateTime>
pub fn get_stopped(&self) -> &Option<DateTime>
The suite's stop time.
Sourcepub fn set_counters(self, input: Option<Counters>) -> Self
pub fn set_counters(self, input: Option<Counters>) -> Self
The suite's result counters.
Sourcepub fn get_counters(&self) -> &Option<Counters>
pub fn get_counters(&self) -> &Option<Counters>
The suite's result counters.
Sourcepub fn set_message(self, input: Option<String>) -> Self
pub fn set_message(self, input: Option<String>) -> Self
A message about the suite's result.
Sourcepub fn get_message(&self) -> &Option<String>
pub fn get_message(&self) -> &Option<String>
A message about the suite's result.
Sourcepub fn device_minutes(self, input: DeviceMinutes) -> Self
pub fn device_minutes(self, input: DeviceMinutes) -> Self
Represents the total (metered or unmetered) minutes used by the test suite.
Sourcepub fn set_device_minutes(self, input: Option<DeviceMinutes>) -> Self
pub fn set_device_minutes(self, input: Option<DeviceMinutes>) -> Self
Represents the total (metered or unmetered) minutes used by the test suite.
Sourcepub fn get_device_minutes(&self) -> &Option<DeviceMinutes>
pub fn get_device_minutes(&self) -> &Option<DeviceMinutes>
Represents the total (metered or unmetered) minutes used by the test suite.
Trait Implementations§
Source§impl Clone for SuiteBuilder
impl Clone for SuiteBuilder
Source§fn clone(&self) -> SuiteBuilder
fn clone(&self) -> SuiteBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for SuiteBuilder
impl Debug for SuiteBuilder
Source§impl Default for SuiteBuilder
impl Default for SuiteBuilder
Source§fn default() -> SuiteBuilder
fn default() -> SuiteBuilder
Source§impl PartialEq for SuiteBuilder
impl PartialEq for SuiteBuilder
impl StructuralPartialEq for SuiteBuilder
Auto Trait Implementations§
impl Freeze for SuiteBuilder
impl RefUnwindSafe for SuiteBuilder
impl Send for SuiteBuilder
impl Sync for SuiteBuilder
impl Unpin for SuiteBuilder
impl UnwindSafe for SuiteBuilder
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>
Returns self
with the
fg()
set to
Color::BrightBlack
.
§Example
println!("{}", value.bright_black());
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>
Returns self
with the
fg()
set to
Color::BrightGreen
.
§Example
println!("{}", value.bright_green());
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightYellow
.
§Example
println!("{}", value.bright_yellow());
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>
Returns self
with the
fg()
set to
Color::BrightMagenta
.
§Example
println!("{}", value.bright_magenta());
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>
Returns self
with the
fg()
set to
Color::BrightWhite
.
§Example
println!("{}", value.bright_white());
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>
Returns self
with the
bg()
set to
Color::BrightBlack
.
§Example
println!("{}", value.on_bright_black());
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>
Returns self
with the
bg()
set to
Color::BrightGreen
.
§Example
println!("{}", value.on_bright_green());
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightYellow
.
§Example
println!("{}", value.on_bright_yellow());
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightBlue
.
§Example
println!("{}", value.on_bright_blue());
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightMagenta
.
§Example
println!("{}", value.on_bright_magenta());
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightCyan
.
§Example
println!("{}", value.on_bright_cyan());
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightWhite
.
§Example
println!("{}", value.on_bright_white());
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 underline(&self) -> Painted<&T>
fn underline(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::Underline
.
§Example
println!("{}", value.underline());
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::RapidBlink
.
§Example
println!("{}", value.rapid_blink());
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);