#[non_exhaustive]pub struct TestStateOutputBuilder { /* private fields */ }
Expand description
A builder for TestStateOutput
.
Implementations§
Source§impl TestStateOutputBuilder
impl TestStateOutputBuilder
Sourcepub fn output(self, input: impl Into<String>) -> Self
pub fn output(self, input: impl Into<String>) -> Self
The JSON output data of the state. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.
Sourcepub fn set_output(self, input: Option<String>) -> Self
pub fn set_output(self, input: Option<String>) -> Self
The JSON output data of the state. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.
Sourcepub fn get_output(&self) -> &Option<String>
pub fn get_output(&self) -> &Option<String>
The JSON output data of the state. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.
Sourcepub fn error(self, input: impl Into<String>) -> Self
pub fn error(self, input: impl Into<String>) -> Self
The error returned when the execution of a state fails.
Sourcepub fn set_error(self, input: Option<String>) -> Self
pub fn set_error(self, input: Option<String>) -> Self
The error returned when the execution of a state fails.
Sourcepub fn get_error(&self) -> &Option<String>
pub fn get_error(&self) -> &Option<String>
The error returned when the execution of a state fails.
Sourcepub fn cause(self, input: impl Into<String>) -> Self
pub fn cause(self, input: impl Into<String>) -> Self
A detailed explanation of the cause for the error when the execution of a state fails.
Sourcepub fn set_cause(self, input: Option<String>) -> Self
pub fn set_cause(self, input: Option<String>) -> Self
A detailed explanation of the cause for the error when the execution of a state fails.
Sourcepub fn get_cause(&self) -> &Option<String>
pub fn get_cause(&self) -> &Option<String>
A detailed explanation of the cause for the error when the execution of a state fails.
Sourcepub fn inspection_data(self, input: InspectionData) -> Self
pub fn inspection_data(self, input: InspectionData) -> Self
Returns additional details about the state's execution, including its input and output data processing flow, and HTTP request and response information. The inspectionLevel
request parameter specifies which details are returned.
Sourcepub fn set_inspection_data(self, input: Option<InspectionData>) -> Self
pub fn set_inspection_data(self, input: Option<InspectionData>) -> Self
Returns additional details about the state's execution, including its input and output data processing flow, and HTTP request and response information. The inspectionLevel
request parameter specifies which details are returned.
Sourcepub fn get_inspection_data(&self) -> &Option<InspectionData>
pub fn get_inspection_data(&self) -> &Option<InspectionData>
Returns additional details about the state's execution, including its input and output data processing flow, and HTTP request and response information. The inspectionLevel
request parameter specifies which details are returned.
Sourcepub fn next_state(self, input: impl Into<String>) -> Self
pub fn next_state(self, input: impl Into<String>) -> Self
The name of the next state to transition to. If you haven't defined a next state in your definition or if the execution of the state fails, this field doesn't contain a value.
Sourcepub fn set_next_state(self, input: Option<String>) -> Self
pub fn set_next_state(self, input: Option<String>) -> Self
The name of the next state to transition to. If you haven't defined a next state in your definition or if the execution of the state fails, this field doesn't contain a value.
Sourcepub fn get_next_state(&self) -> &Option<String>
pub fn get_next_state(&self) -> &Option<String>
The name of the next state to transition to. If you haven't defined a next state in your definition or if the execution of the state fails, this field doesn't contain a value.
Sourcepub fn status(self, input: TestExecutionStatus) -> Self
pub fn status(self, input: TestExecutionStatus) -> Self
The execution status of the state.
Sourcepub fn set_status(self, input: Option<TestExecutionStatus>) -> Self
pub fn set_status(self, input: Option<TestExecutionStatus>) -> Self
The execution status of the state.
Sourcepub fn get_status(&self) -> &Option<TestExecutionStatus>
pub fn get_status(&self) -> &Option<TestExecutionStatus>
The execution status of the state.
Sourcepub fn build(self) -> TestStateOutput
pub fn build(self) -> TestStateOutput
Consumes the builder and constructs a TestStateOutput
.
Trait Implementations§
Source§impl Clone for TestStateOutputBuilder
impl Clone for TestStateOutputBuilder
Source§fn clone(&self) -> TestStateOutputBuilder
fn clone(&self) -> TestStateOutputBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for TestStateOutputBuilder
impl Debug for TestStateOutputBuilder
Source§impl Default for TestStateOutputBuilder
impl Default for TestStateOutputBuilder
Source§fn default() -> TestStateOutputBuilder
fn default() -> TestStateOutputBuilder
Source§impl PartialEq for TestStateOutputBuilder
impl PartialEq for TestStateOutputBuilder
impl StructuralPartialEq for TestStateOutputBuilder
Auto Trait Implementations§
impl Freeze for TestStateOutputBuilder
impl RefUnwindSafe for TestStateOutputBuilder
impl Send for TestStateOutputBuilder
impl Sync for TestStateOutputBuilder
impl Unpin for TestStateOutputBuilder
impl UnwindSafe for TestStateOutputBuilder
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);