FlowValidationDetails

Enum FlowValidationDetails 

Source
#[non_exhaustive]
pub enum FlowValidationDetails {
Show 34 variants CyclicConnection(CyclicConnectionFlowValidationDetails), DuplicateConditionExpression(DuplicateConditionExpressionFlowValidationDetails), DuplicateConnections(DuplicateConnectionsFlowValidationDetails), IncompatibleConnectionDataType(IncompatibleConnectionDataTypeFlowValidationDetails), InvalidLoopBoundary(InvalidLoopBoundaryFlowValidationDetails), LoopIncompatibleNodeType(LoopIncompatibleNodeTypeFlowValidationDetails), MalformedConditionExpression(MalformedConditionExpressionFlowValidationDetails), MalformedNodeInputExpression(MalformedNodeInputExpressionFlowValidationDetails), MismatchedNodeInputType(MismatchedNodeInputTypeFlowValidationDetails), MismatchedNodeOutputType(MismatchedNodeOutputTypeFlowValidationDetails), MissingConnectionConfiguration(MissingConnectionConfigurationFlowValidationDetails), MissingDefaultCondition(MissingDefaultConditionFlowValidationDetails), MissingEndingNodes(MissingEndingNodesFlowValidationDetails), MissingLoopControllerNode(MissingLoopControllerNodeFlowValidationDetails), MissingLoopInputNode(MissingLoopInputNodeFlowValidationDetails), MissingNodeConfiguration(MissingNodeConfigurationFlowValidationDetails), MissingNodeInput(MissingNodeInputFlowValidationDetails), MissingNodeOutput(MissingNodeOutputFlowValidationDetails), MissingStartingNodes(MissingStartingNodesFlowValidationDetails), MultipleLoopControllerNodes(MultipleLoopControllerNodesFlowValidationDetails), MultipleLoopInputNodes(MultipleLoopInputNodesFlowValidationDetails), MultipleNodeInputConnections(MultipleNodeInputConnectionsFlowValidationDetails), UnfulfilledNodeInput(UnfulfilledNodeInputFlowValidationDetails), UnknownConnectionCondition(UnknownConnectionConditionFlowValidationDetails), UnknownConnectionSource(UnknownConnectionSourceFlowValidationDetails), UnknownConnectionSourceOutput(UnknownConnectionSourceOutputFlowValidationDetails), UnknownConnectionTarget(UnknownConnectionTargetFlowValidationDetails), UnknownConnectionTargetInput(UnknownConnectionTargetInputFlowValidationDetails), UnknownNodeInput(UnknownNodeInputFlowValidationDetails), UnknownNodeOutput(UnknownNodeOutputFlowValidationDetails), UnreachableNode(UnreachableNodeFlowValidationDetails), UnsatisfiedConnectionConditions(UnsatisfiedConnectionConditionsFlowValidationDetails), Unspecified(UnspecifiedFlowValidationDetails),
#[non_exhaustive]
Unknown,
}
Expand description

A union type containing various possible validation issues in the flow.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

CyclicConnection(CyclicConnectionFlowValidationDetails)

Details about a cyclic connection in the flow.

§

DuplicateConditionExpression(DuplicateConditionExpressionFlowValidationDetails)

Details about duplicate condition expressions in a node.

§

DuplicateConnections(DuplicateConnectionsFlowValidationDetails)

Details about duplicate connections between nodes.

§

IncompatibleConnectionDataType(IncompatibleConnectionDataTypeFlowValidationDetails)

Details about incompatible data types in a connection.

§

InvalidLoopBoundary(InvalidLoopBoundaryFlowValidationDetails)

Details about a flow that includes connections that violate loop boundary rules.

§

LoopIncompatibleNodeType(LoopIncompatibleNodeTypeFlowValidationDetails)

Details about a flow that includes incompatible node types in a DoWhile loop.

§

MalformedConditionExpression(MalformedConditionExpressionFlowValidationDetails)

Details about a malformed condition expression in a node.

§

MalformedNodeInputExpression(MalformedNodeInputExpressionFlowValidationDetails)

Details about a malformed input expression in a node.

§

MismatchedNodeInputType(MismatchedNodeInputTypeFlowValidationDetails)

Details about mismatched input data types in a node.

§

MismatchedNodeOutputType(MismatchedNodeOutputTypeFlowValidationDetails)

Details about mismatched output data types in a node.

§

MissingConnectionConfiguration(MissingConnectionConfigurationFlowValidationDetails)

Details about missing configuration for a connection.

§

MissingDefaultCondition(MissingDefaultConditionFlowValidationDetails)

Details about a missing default condition in a conditional node.

§

MissingEndingNodes(MissingEndingNodesFlowValidationDetails)

Details about missing ending nodes in the flow.

§

MissingLoopControllerNode(MissingLoopControllerNodeFlowValidationDetails)

Details about a flow that's missing a required LoopController node in a DoWhile loop.

§

MissingLoopInputNode(MissingLoopInputNodeFlowValidationDetails)

Details about a flow that's missing a required LoopInput node in a DoWhile loop.

§

MissingNodeConfiguration(MissingNodeConfigurationFlowValidationDetails)

Details about missing configuration for a node.

§

MissingNodeInput(MissingNodeInputFlowValidationDetails)

Details about a missing required input in a node.

§

MissingNodeOutput(MissingNodeOutputFlowValidationDetails)

Details about a missing required output in a node.

§

MissingStartingNodes(MissingStartingNodesFlowValidationDetails)

Details about missing starting nodes in the flow.

§

MultipleLoopControllerNodes(MultipleLoopControllerNodesFlowValidationDetails)

Details about a flow that contains multiple LoopController nodes in a DoWhile loop.

§

MultipleLoopInputNodes(MultipleLoopInputNodesFlowValidationDetails)

Details about a flow that contains multiple LoopInput nodes in a DoWhile loop.

§

MultipleNodeInputConnections(MultipleNodeInputConnectionsFlowValidationDetails)

Details about multiple connections to a single node input.

§

UnfulfilledNodeInput(UnfulfilledNodeInputFlowValidationDetails)

Details about an unfulfilled node input with no valid connections.

§

UnknownConnectionCondition(UnknownConnectionConditionFlowValidationDetails)

Details about an unknown condition for a connection.

§

UnknownConnectionSource(UnknownConnectionSourceFlowValidationDetails)

Details about an unknown source node for a connection.

§

UnknownConnectionSourceOutput(UnknownConnectionSourceOutputFlowValidationDetails)

Details about an unknown source output for a connection.

§

UnknownConnectionTarget(UnknownConnectionTargetFlowValidationDetails)

Details about an unknown target node for a connection.

§

UnknownConnectionTargetInput(UnknownConnectionTargetInputFlowValidationDetails)

Details about an unknown target input for a connection.

§

UnknownNodeInput(UnknownNodeInputFlowValidationDetails)

Details about an unknown input for a node.

§

UnknownNodeOutput(UnknownNodeOutputFlowValidationDetails)

Details about an unknown output for a node.

§

UnreachableNode(UnreachableNodeFlowValidationDetails)

Details about an unreachable node in the flow.

§

UnsatisfiedConnectionConditions(UnsatisfiedConnectionConditionsFlowValidationDetails)

Details about unsatisfied conditions for a connection.

§

Unspecified(UnspecifiedFlowValidationDetails)

Details about an unspecified validation.

§

#[non_exhaustive]
Unknown

The Unknown variant represents cases where new union variant was received. Consider upgrading the SDK to the latest available version. An unknown enum variant

Note: If you encounter this error, consider upgrading your SDK to the latest version. The Unknown variant represents cases where the server sent a value that wasn’t recognized by the client. This can happen when the server adds new functionality, but the client has not been updated. To investigate this, consider turning on debug logging to print the raw HTTP response.

Implementations§

Source§

impl FlowValidationDetails

Source

pub fn as_cyclic_connection( &self, ) -> Result<&CyclicConnectionFlowValidationDetails, &Self>

Tries to convert the enum instance into CyclicConnection, extracting the inner CyclicConnectionFlowValidationDetails. Returns Err(&Self) if it can’t be converted.

Source

pub fn is_cyclic_connection(&self) -> bool

Returns true if this is a CyclicConnection.

Source

pub fn as_duplicate_condition_expression( &self, ) -> Result<&DuplicateConditionExpressionFlowValidationDetails, &Self>

Tries to convert the enum instance into DuplicateConditionExpression, extracting the inner DuplicateConditionExpressionFlowValidationDetails. Returns Err(&Self) if it can’t be converted.

Source

pub fn is_duplicate_condition_expression(&self) -> bool

Returns true if this is a DuplicateConditionExpression.

Source

pub fn as_duplicate_connections( &self, ) -> Result<&DuplicateConnectionsFlowValidationDetails, &Self>

Tries to convert the enum instance into DuplicateConnections, extracting the inner DuplicateConnectionsFlowValidationDetails. Returns Err(&Self) if it can’t be converted.

Source

pub fn is_duplicate_connections(&self) -> bool

Returns true if this is a DuplicateConnections.

Source

pub fn as_incompatible_connection_data_type( &self, ) -> Result<&IncompatibleConnectionDataTypeFlowValidationDetails, &Self>

Tries to convert the enum instance into IncompatibleConnectionDataType, extracting the inner IncompatibleConnectionDataTypeFlowValidationDetails. Returns Err(&Self) if it can’t be converted.

Source

pub fn is_incompatible_connection_data_type(&self) -> bool

Returns true if this is a IncompatibleConnectionDataType.

Source

pub fn as_invalid_loop_boundary( &self, ) -> Result<&InvalidLoopBoundaryFlowValidationDetails, &Self>

Tries to convert the enum instance into InvalidLoopBoundary, extracting the inner InvalidLoopBoundaryFlowValidationDetails. Returns Err(&Self) if it can’t be converted.

Source

pub fn is_invalid_loop_boundary(&self) -> bool

Returns true if this is a InvalidLoopBoundary.

Source

pub fn as_loop_incompatible_node_type( &self, ) -> Result<&LoopIncompatibleNodeTypeFlowValidationDetails, &Self>

Tries to convert the enum instance into LoopIncompatibleNodeType, extracting the inner LoopIncompatibleNodeTypeFlowValidationDetails. Returns Err(&Self) if it can’t be converted.

Source

pub fn is_loop_incompatible_node_type(&self) -> bool

Returns true if this is a LoopIncompatibleNodeType.

Source

pub fn as_malformed_condition_expression( &self, ) -> Result<&MalformedConditionExpressionFlowValidationDetails, &Self>

Tries to convert the enum instance into MalformedConditionExpression, extracting the inner MalformedConditionExpressionFlowValidationDetails. Returns Err(&Self) if it can’t be converted.

Source

pub fn is_malformed_condition_expression(&self) -> bool

Returns true if this is a MalformedConditionExpression.

Source

pub fn as_malformed_node_input_expression( &self, ) -> Result<&MalformedNodeInputExpressionFlowValidationDetails, &Self>

Tries to convert the enum instance into MalformedNodeInputExpression, extracting the inner MalformedNodeInputExpressionFlowValidationDetails. Returns Err(&Self) if it can’t be converted.

Source

pub fn is_malformed_node_input_expression(&self) -> bool

Returns true if this is a MalformedNodeInputExpression.

Source

pub fn as_mismatched_node_input_type( &self, ) -> Result<&MismatchedNodeInputTypeFlowValidationDetails, &Self>

Tries to convert the enum instance into MismatchedNodeInputType, extracting the inner MismatchedNodeInputTypeFlowValidationDetails. Returns Err(&Self) if it can’t be converted.

Source

pub fn is_mismatched_node_input_type(&self) -> bool

Returns true if this is a MismatchedNodeInputType.

Source

pub fn as_mismatched_node_output_type( &self, ) -> Result<&MismatchedNodeOutputTypeFlowValidationDetails, &Self>

Tries to convert the enum instance into MismatchedNodeOutputType, extracting the inner MismatchedNodeOutputTypeFlowValidationDetails. Returns Err(&Self) if it can’t be converted.

Source

pub fn is_mismatched_node_output_type(&self) -> bool

Returns true if this is a MismatchedNodeOutputType.

Source

pub fn as_missing_connection_configuration( &self, ) -> Result<&MissingConnectionConfigurationFlowValidationDetails, &Self>

Tries to convert the enum instance into MissingConnectionConfiguration, extracting the inner MissingConnectionConfigurationFlowValidationDetails. Returns Err(&Self) if it can’t be converted.

Source

pub fn is_missing_connection_configuration(&self) -> bool

Returns true if this is a MissingConnectionConfiguration.

Source

pub fn as_missing_default_condition( &self, ) -> Result<&MissingDefaultConditionFlowValidationDetails, &Self>

Tries to convert the enum instance into MissingDefaultCondition, extracting the inner MissingDefaultConditionFlowValidationDetails. Returns Err(&Self) if it can’t be converted.

Source

pub fn is_missing_default_condition(&self) -> bool

Returns true if this is a MissingDefaultCondition.

Source

pub fn as_missing_ending_nodes( &self, ) -> Result<&MissingEndingNodesFlowValidationDetails, &Self>

Tries to convert the enum instance into MissingEndingNodes, extracting the inner MissingEndingNodesFlowValidationDetails. Returns Err(&Self) if it can’t be converted.

Source

pub fn is_missing_ending_nodes(&self) -> bool

Returns true if this is a MissingEndingNodes.

Source

pub fn as_missing_loop_controller_node( &self, ) -> Result<&MissingLoopControllerNodeFlowValidationDetails, &Self>

Tries to convert the enum instance into MissingLoopControllerNode, extracting the inner MissingLoopControllerNodeFlowValidationDetails. Returns Err(&Self) if it can’t be converted.

Source

pub fn is_missing_loop_controller_node(&self) -> bool

Returns true if this is a MissingLoopControllerNode.

Source

pub fn as_missing_loop_input_node( &self, ) -> Result<&MissingLoopInputNodeFlowValidationDetails, &Self>

Tries to convert the enum instance into MissingLoopInputNode, extracting the inner MissingLoopInputNodeFlowValidationDetails. Returns Err(&Self) if it can’t be converted.

Source

pub fn is_missing_loop_input_node(&self) -> bool

Returns true if this is a MissingLoopInputNode.

Source

pub fn as_missing_node_configuration( &self, ) -> Result<&MissingNodeConfigurationFlowValidationDetails, &Self>

Tries to convert the enum instance into MissingNodeConfiguration, extracting the inner MissingNodeConfigurationFlowValidationDetails. Returns Err(&Self) if it can’t be converted.

Source

pub fn is_missing_node_configuration(&self) -> bool

Returns true if this is a MissingNodeConfiguration.

Source

pub fn as_missing_node_input( &self, ) -> Result<&MissingNodeInputFlowValidationDetails, &Self>

Tries to convert the enum instance into MissingNodeInput, extracting the inner MissingNodeInputFlowValidationDetails. Returns Err(&Self) if it can’t be converted.

Source

pub fn is_missing_node_input(&self) -> bool

Returns true if this is a MissingNodeInput.

Source

pub fn as_missing_node_output( &self, ) -> Result<&MissingNodeOutputFlowValidationDetails, &Self>

Tries to convert the enum instance into MissingNodeOutput, extracting the inner MissingNodeOutputFlowValidationDetails. Returns Err(&Self) if it can’t be converted.

Source

pub fn is_missing_node_output(&self) -> bool

Returns true if this is a MissingNodeOutput.

Source

pub fn as_missing_starting_nodes( &self, ) -> Result<&MissingStartingNodesFlowValidationDetails, &Self>

Tries to convert the enum instance into MissingStartingNodes, extracting the inner MissingStartingNodesFlowValidationDetails. Returns Err(&Self) if it can’t be converted.

Source

pub fn is_missing_starting_nodes(&self) -> bool

Returns true if this is a MissingStartingNodes.

Source

pub fn as_multiple_loop_controller_nodes( &self, ) -> Result<&MultipleLoopControllerNodesFlowValidationDetails, &Self>

Tries to convert the enum instance into MultipleLoopControllerNodes, extracting the inner MultipleLoopControllerNodesFlowValidationDetails. Returns Err(&Self) if it can’t be converted.

Source

pub fn is_multiple_loop_controller_nodes(&self) -> bool

Returns true if this is a MultipleLoopControllerNodes.

Source

pub fn as_multiple_loop_input_nodes( &self, ) -> Result<&MultipleLoopInputNodesFlowValidationDetails, &Self>

Tries to convert the enum instance into MultipleLoopInputNodes, extracting the inner MultipleLoopInputNodesFlowValidationDetails. Returns Err(&Self) if it can’t be converted.

Source

pub fn is_multiple_loop_input_nodes(&self) -> bool

Returns true if this is a MultipleLoopInputNodes.

Source

pub fn as_multiple_node_input_connections( &self, ) -> Result<&MultipleNodeInputConnectionsFlowValidationDetails, &Self>

Tries to convert the enum instance into MultipleNodeInputConnections, extracting the inner MultipleNodeInputConnectionsFlowValidationDetails. Returns Err(&Self) if it can’t be converted.

Source

pub fn is_multiple_node_input_connections(&self) -> bool

Returns true if this is a MultipleNodeInputConnections.

Source

pub fn as_unfulfilled_node_input( &self, ) -> Result<&UnfulfilledNodeInputFlowValidationDetails, &Self>

Tries to convert the enum instance into UnfulfilledNodeInput, extracting the inner UnfulfilledNodeInputFlowValidationDetails. Returns Err(&Self) if it can’t be converted.

Source

pub fn is_unfulfilled_node_input(&self) -> bool

Returns true if this is a UnfulfilledNodeInput.

Source

pub fn as_unknown_connection_condition( &self, ) -> Result<&UnknownConnectionConditionFlowValidationDetails, &Self>

Tries to convert the enum instance into UnknownConnectionCondition, extracting the inner UnknownConnectionConditionFlowValidationDetails. Returns Err(&Self) if it can’t be converted.

Source

pub fn is_unknown_connection_condition(&self) -> bool

Returns true if this is a UnknownConnectionCondition.

Source

pub fn as_unknown_connection_source( &self, ) -> Result<&UnknownConnectionSourceFlowValidationDetails, &Self>

Tries to convert the enum instance into UnknownConnectionSource, extracting the inner UnknownConnectionSourceFlowValidationDetails. Returns Err(&Self) if it can’t be converted.

Source

pub fn is_unknown_connection_source(&self) -> bool

Returns true if this is a UnknownConnectionSource.

Source

pub fn as_unknown_connection_source_output( &self, ) -> Result<&UnknownConnectionSourceOutputFlowValidationDetails, &Self>

Tries to convert the enum instance into UnknownConnectionSourceOutput, extracting the inner UnknownConnectionSourceOutputFlowValidationDetails. Returns Err(&Self) if it can’t be converted.

Source

pub fn is_unknown_connection_source_output(&self) -> bool

Returns true if this is a UnknownConnectionSourceOutput.

Source

pub fn as_unknown_connection_target( &self, ) -> Result<&UnknownConnectionTargetFlowValidationDetails, &Self>

Tries to convert the enum instance into UnknownConnectionTarget, extracting the inner UnknownConnectionTargetFlowValidationDetails. Returns Err(&Self) if it can’t be converted.

Source

pub fn is_unknown_connection_target(&self) -> bool

Returns true if this is a UnknownConnectionTarget.

Source

pub fn as_unknown_connection_target_input( &self, ) -> Result<&UnknownConnectionTargetInputFlowValidationDetails, &Self>

Tries to convert the enum instance into UnknownConnectionTargetInput, extracting the inner UnknownConnectionTargetInputFlowValidationDetails. Returns Err(&Self) if it can’t be converted.

Source

pub fn is_unknown_connection_target_input(&self) -> bool

Returns true if this is a UnknownConnectionTargetInput.

Source

pub fn as_unknown_node_input( &self, ) -> Result<&UnknownNodeInputFlowValidationDetails, &Self>

Tries to convert the enum instance into UnknownNodeInput, extracting the inner UnknownNodeInputFlowValidationDetails. Returns Err(&Self) if it can’t be converted.

Source

pub fn is_unknown_node_input(&self) -> bool

Returns true if this is a UnknownNodeInput.

Source

pub fn as_unknown_node_output( &self, ) -> Result<&UnknownNodeOutputFlowValidationDetails, &Self>

Tries to convert the enum instance into UnknownNodeOutput, extracting the inner UnknownNodeOutputFlowValidationDetails. Returns Err(&Self) if it can’t be converted.

Source

pub fn is_unknown_node_output(&self) -> bool

Returns true if this is a UnknownNodeOutput.

Source

pub fn as_unreachable_node( &self, ) -> Result<&UnreachableNodeFlowValidationDetails, &Self>

Tries to convert the enum instance into UnreachableNode, extracting the inner UnreachableNodeFlowValidationDetails. Returns Err(&Self) if it can’t be converted.

Source

pub fn is_unreachable_node(&self) -> bool

Returns true if this is a UnreachableNode.

Source

pub fn as_unsatisfied_connection_conditions( &self, ) -> Result<&UnsatisfiedConnectionConditionsFlowValidationDetails, &Self>

Tries to convert the enum instance into UnsatisfiedConnectionConditions, extracting the inner UnsatisfiedConnectionConditionsFlowValidationDetails. Returns Err(&Self) if it can’t be converted.

Source

pub fn is_unsatisfied_connection_conditions(&self) -> bool

Returns true if this is a UnsatisfiedConnectionConditions.

Source

pub fn as_unspecified(&self) -> Result<&UnspecifiedFlowValidationDetails, &Self>

Tries to convert the enum instance into Unspecified, extracting the inner UnspecifiedFlowValidationDetails. Returns Err(&Self) if it can’t be converted.

Source

pub fn is_unspecified(&self) -> bool

Returns true if this is a Unspecified.

Source

pub fn is_unknown(&self) -> bool

Returns true if the enum instance is the Unknown variant.

Trait Implementations§

Source§

impl Clone for FlowValidationDetails

Source§

fn clone(&self) -> FlowValidationDetails

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for FlowValidationDetails

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl PartialEq for FlowValidationDetails

Source§

fn eq(&self, other: &FlowValidationDetails) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for FlowValidationDetails

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts 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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts 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 more
Source§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

Source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
Source§

impl<T> Paint for T
where T: ?Sized,

Source§

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 primary(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Primary].

§Example
println!("{}", value.primary());
Source§

fn fixed(&self, color: u8) -> Painted<&T>

Returns self with the fg() set to [Color :: Fixed].

§Example
println!("{}", value.fixed(color));
Source§

fn rgb(&self, r: u8, g: u8, b: u8) -> Painted<&T>

Returns self with the fg() set to [Color :: Rgb].

§Example
println!("{}", value.rgb(r, g, b));
Source§

fn black(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Black].

§Example
println!("{}", value.black());
Source§

fn red(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Red].

§Example
println!("{}", value.red());
Source§

fn green(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Green].

§Example
println!("{}", value.green());
Source§

fn yellow(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Yellow].

§Example
println!("{}", value.yellow());
Source§

fn blue(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Blue].

§Example
println!("{}", value.blue());
Source§

fn magenta(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Magenta].

§Example
println!("{}", value.magenta());
Source§

fn cyan(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Cyan].

§Example
println!("{}", value.cyan());
Source§

fn white(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: White].

§Example
println!("{}", value.white());
Source§

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>

Returns self with the fg() set to [Color :: BrightRed].

§Example
println!("{}", value.bright_red());
Source§

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>

Returns self with the fg() set to [Color :: BrightYellow].

§Example
println!("{}", value.bright_yellow());
Source§

fn bright_blue(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightBlue].

§Example
println!("{}", value.bright_blue());
Source§

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>

Returns self with the fg() set to [Color :: BrightCyan].

§Example
println!("{}", value.bright_cyan());
Source§

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>

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>

Returns self with the bg() set to [Color :: Primary].

§Example
println!("{}", value.on_primary());
Source§

fn on_fixed(&self, color: u8) -> Painted<&T>

Returns self with the bg() set to [Color :: Fixed].

§Example
println!("{}", value.on_fixed(color));
Source§

fn on_rgb(&self, r: u8, g: u8, b: u8) -> Painted<&T>

Returns self with the bg() set to [Color :: Rgb].

§Example
println!("{}", value.on_rgb(r, g, b));
Source§

fn on_black(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Black].

§Example
println!("{}", value.on_black());
Source§

fn on_red(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Red].

§Example
println!("{}", value.on_red());
Source§

fn on_green(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Green].

§Example
println!("{}", value.on_green());
Source§

fn on_yellow(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Yellow].

§Example
println!("{}", value.on_yellow());
Source§

fn on_blue(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Blue].

§Example
println!("{}", value.on_blue());
Source§

fn on_magenta(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Magenta].

§Example
println!("{}", value.on_magenta());
Source§

fn on_cyan(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Cyan].

§Example
println!("{}", value.on_cyan());
Source§

fn on_white(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: White].

§Example
println!("{}", value.on_white());
Source§

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>

Returns self with the bg() set to [Color :: BrightRed].

§Example
println!("{}", value.on_bright_red());
Source§

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>

Returns self with the bg() set to [Color :: BrightYellow].

§Example
println!("{}", value.on_bright_yellow());
Source§

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>

Returns self with the bg() set to [Color :: BrightMagenta].

§Example
println!("{}", value.on_bright_magenta());
Source§

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>

Returns self with the bg() set to [Color :: BrightWhite].

§Example
println!("{}", value.on_bright_white());
Source§

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 bold(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Bold].

§Example
println!("{}", value.bold());
Source§

fn dim(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Dim].

§Example
println!("{}", value.dim());
Source§

fn italic(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Italic].

§Example
println!("{}", value.italic());
Source§

fn underline(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Underline].

§Example
println!("{}", value.underline());

Returns self with the attr() set to [Attribute :: Blink].

§Example
println!("{}", value.blink());

Returns self with the attr() set to [Attribute :: RapidBlink].

§Example
println!("{}", value.rapid_blink());
Source§

fn invert(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Invert].

§Example
println!("{}", value.invert());
Source§

fn conceal(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Conceal].

§Example
println!("{}", value.conceal());
Source§

fn strike(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Strike].

§Example
println!("{}", value.strike());
Source§

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 mask(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Mask].

§Example
println!("{}", value.mask());
Source§

fn wrap(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Wrap].

§Example
println!("{}", value.wrap());
Source§

fn linger(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Linger].

§Example
println!("{}", value.linger());
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.

Returns self with the quirk() set to [Quirk :: Clear].

§Example
println!("{}", value.clear());
Source§

fn resetting(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Resetting].

§Example
println!("{}", value.resetting());
Source§

fn bright(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Bright].

§Example
println!("{}", value.bright());
Source§

fn on_bright(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: OnBright].

§Example
println!("{}", value.on_bright());
Source§

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);
Source§

fn new(self) -> Painted<Self>
where Self: Sized,

Create a new Painted with a default Style. Read more
Source§

fn paint<S>(&self, style: S) -> Painted<&Self>
where S: Into<Style>,

Apply a style wholesale to self. Any previous style is replaced. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,