#[non_exhaustive]pub struct FlowValidationBuilder { /* private fields */ }
Expand description
A builder for FlowValidation
.
Implementations§
Source§impl FlowValidationBuilder
impl FlowValidationBuilder
Sourcepub fn message(self, input: impl Into<String>) -> Self
pub fn message(self, input: impl Into<String>) -> Self
A message describing the validation error.
This field is required.Sourcepub fn set_message(self, input: Option<String>) -> Self
pub fn set_message(self, input: Option<String>) -> Self
A message describing the validation error.
Sourcepub fn get_message(&self) -> &Option<String>
pub fn get_message(&self) -> &Option<String>
A message describing the validation error.
Sourcepub fn severity(self, input: FlowValidationSeverity) -> Self
pub fn severity(self, input: FlowValidationSeverity) -> Self
The severity of the issue described in the message.
This field is required.Sourcepub fn set_severity(self, input: Option<FlowValidationSeverity>) -> Self
pub fn set_severity(self, input: Option<FlowValidationSeverity>) -> Self
The severity of the issue described in the message.
Sourcepub fn get_severity(&self) -> &Option<FlowValidationSeverity>
pub fn get_severity(&self) -> &Option<FlowValidationSeverity>
The severity of the issue described in the message.
Sourcepub fn details(self, input: FlowValidationDetails) -> Self
pub fn details(self, input: FlowValidationDetails) -> Self
Specific details about the validation issue encountered in the flow.
Sourcepub fn set_details(self, input: Option<FlowValidationDetails>) -> Self
pub fn set_details(self, input: Option<FlowValidationDetails>) -> Self
Specific details about the validation issue encountered in the flow.
Sourcepub fn get_details(&self) -> &Option<FlowValidationDetails>
pub fn get_details(&self) -> &Option<FlowValidationDetails>
Specific details about the validation issue encountered in the flow.
Sourcepub fn type(self, input: FlowValidationType) -> Self
pub fn type(self, input: FlowValidationType) -> Self
The type of validation issue encountered in the flow.
Sourcepub fn set_type(self, input: Option<FlowValidationType>) -> Self
pub fn set_type(self, input: Option<FlowValidationType>) -> Self
The type of validation issue encountered in the flow.
Sourcepub fn get_type(&self) -> &Option<FlowValidationType>
pub fn get_type(&self) -> &Option<FlowValidationType>
The type of validation issue encountered in the flow.
Sourcepub fn build(self) -> Result<FlowValidation, BuildError>
pub fn build(self) -> Result<FlowValidation, BuildError>
Consumes the builder and constructs a FlowValidation
.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for FlowValidationBuilder
impl Clone for FlowValidationBuilder
Source§fn clone(&self) -> FlowValidationBuilder
fn clone(&self) -> FlowValidationBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for FlowValidationBuilder
impl Debug for FlowValidationBuilder
Source§impl Default for FlowValidationBuilder
impl Default for FlowValidationBuilder
Source§fn default() -> FlowValidationBuilder
fn default() -> FlowValidationBuilder
Source§impl PartialEq for FlowValidationBuilder
impl PartialEq for FlowValidationBuilder
impl StructuralPartialEq for FlowValidationBuilder
Auto Trait Implementations§
impl Freeze for FlowValidationBuilder
impl RefUnwindSafe for FlowValidationBuilder
impl Send for FlowValidationBuilder
impl Sync for FlowValidationBuilder
impl Unpin for FlowValidationBuilder
impl UnwindSafe for FlowValidationBuilder
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);