aws_sdk_sfn::types

Struct HistoryEvent

Source 
#[non_exhaustive]
pub struct HistoryEvent {
Show 41 fields
    pub timestamp: DateTime,
    pub type: HistoryEventType,
    pub id: i64,
    pub previous_event_id: i64,
    pub activity_failed_event_details: Option<ActivityFailedEventDetails>,
    pub activity_schedule_failed_event_details: Option<ActivityScheduleFailedEventDetails>,
    pub activity_scheduled_event_details: Option<ActivityScheduledEventDetails>,
    pub activity_started_event_details: Option<ActivityStartedEventDetails>,
    pub activity_succeeded_event_details: Option<ActivitySucceededEventDetails>,
    pub activity_timed_out_event_details: Option<ActivityTimedOutEventDetails>,
    pub task_failed_event_details: Option<TaskFailedEventDetails>,
    pub task_scheduled_event_details: Option<TaskScheduledEventDetails>,
    pub task_start_failed_event_details: Option<TaskStartFailedEventDetails>,
    pub task_started_event_details: Option<TaskStartedEventDetails>,
    pub task_submit_failed_event_details: Option<TaskSubmitFailedEventDetails>,
    pub task_submitted_event_details: Option<TaskSubmittedEventDetails>,
    pub task_succeeded_event_details: Option<TaskSucceededEventDetails>,
    pub task_timed_out_event_details: Option<TaskTimedOutEventDetails>,
    pub execution_failed_event_details: Option<ExecutionFailedEventDetails>,
    pub execution_started_event_details: Option<ExecutionStartedEventDetails>,
    pub execution_succeeded_event_details: Option<ExecutionSucceededEventDetails>,
    pub execution_aborted_event_details: Option<ExecutionAbortedEventDetails>,
    pub execution_timed_out_event_details: Option<ExecutionTimedOutEventDetails>,
    pub execution_redriven_event_details: Option<ExecutionRedrivenEventDetails>,
    pub map_state_started_event_details: Option<MapStateStartedEventDetails>,
    pub map_iteration_started_event_details: Option<MapIterationEventDetails>,
    pub map_iteration_succeeded_event_details: Option<MapIterationEventDetails>,
    pub map_iteration_failed_event_details: Option<MapIterationEventDetails>,
    pub map_iteration_aborted_event_details: Option<MapIterationEventDetails>,
    pub lambda_function_failed_event_details: Option<LambdaFunctionFailedEventDetails>,
    pub lambda_function_schedule_failed_event_details: Option<LambdaFunctionScheduleFailedEventDetails>,
    pub lambda_function_scheduled_event_details: Option<LambdaFunctionScheduledEventDetails>,
    pub lambda_function_start_failed_event_details: Option<LambdaFunctionStartFailedEventDetails>,
    pub lambda_function_succeeded_event_details: Option<LambdaFunctionSucceededEventDetails>,
    pub lambda_function_timed_out_event_details: Option<LambdaFunctionTimedOutEventDetails>,
    pub state_entered_event_details: Option<StateEnteredEventDetails>,
    pub state_exited_event_details: Option<StateExitedEventDetails>,
    pub map_run_started_event_details: Option<MapRunStartedEventDetails>,
    pub map_run_failed_event_details: Option<MapRunFailedEventDetails>,
    pub map_run_redriven_event_details: Option<MapRunRedrivenEventDetails>,
    pub evaluation_failed_event_details: Option<EvaluationFailedEventDetails>,

}
Expand description

Contains details about the events of an execution.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§timestamp: DateTime

The date and time the event occurred.

§type: HistoryEventType

The type of the event.

§id: i64

The id of the event. Events are numbered sequentially, starting at one.

§previous_event_id: i64

The id of the previous event.

§activity_failed_event_details: Option<ActivityFailedEventDetails>

Contains details about an activity that failed during an execution.

§activity_schedule_failed_event_details: Option<ActivityScheduleFailedEventDetails>

Contains details about an activity schedule event that failed during an execution.

§activity_scheduled_event_details: Option<ActivityScheduledEventDetails>

Contains details about an activity scheduled during an execution.

§activity_started_event_details: Option<ActivityStartedEventDetails>

Contains details about the start of an activity during an execution.

§activity_succeeded_event_details: Option<ActivitySucceededEventDetails>

Contains details about an activity that successfully terminated during an execution.

§activity_timed_out_event_details: Option<ActivityTimedOutEventDetails>

Contains details about an activity timeout that occurred during an execution.

§task_failed_event_details: Option<TaskFailedEventDetails>

Contains details about the failure of a task.

§task_scheduled_event_details: Option<TaskScheduledEventDetails>

Contains details about a task that was scheduled.

§task_start_failed_event_details: Option<TaskStartFailedEventDetails>

Contains details about a task that failed to start.

§task_started_event_details: Option<TaskStartedEventDetails>

Contains details about a task that was started.

§task_submit_failed_event_details: Option<TaskSubmitFailedEventDetails>

Contains details about a task that where the submit failed.

§task_submitted_event_details: Option<TaskSubmittedEventDetails>

Contains details about a submitted task.

§task_succeeded_event_details: Option<TaskSucceededEventDetails>

Contains details about a task that succeeded.

§task_timed_out_event_details: Option<TaskTimedOutEventDetails>

Contains details about a task that timed out.

§execution_failed_event_details: Option<ExecutionFailedEventDetails>

Contains details about an execution failure event.

§execution_started_event_details: Option<ExecutionStartedEventDetails>

Contains details about the start of the execution.

§execution_succeeded_event_details: Option<ExecutionSucceededEventDetails>

Contains details about the successful termination of the execution.

§execution_aborted_event_details: Option<ExecutionAbortedEventDetails>

Contains details about an abort of an execution.

§execution_timed_out_event_details: Option<ExecutionTimedOutEventDetails>

Contains details about the execution timeout that occurred during the execution.

§execution_redriven_event_details: Option<ExecutionRedrivenEventDetails>

Contains details about the redrive attempt of an execution.

§map_state_started_event_details: Option<MapStateStartedEventDetails>

Contains details about Map state that was started.

§map_iteration_started_event_details: Option<MapIterationEventDetails>

Contains details about an iteration of a Map state that was started.

§map_iteration_succeeded_event_details: Option<MapIterationEventDetails>

Contains details about an iteration of a Map state that succeeded.

§map_iteration_failed_event_details: Option<MapIterationEventDetails>

Contains details about an iteration of a Map state that failed.

§map_iteration_aborted_event_details: Option<MapIterationEventDetails>

Contains details about an iteration of a Map state that was aborted.

§lambda_function_failed_event_details: Option<LambdaFunctionFailedEventDetails>

Contains details about a Lambda function that failed during an execution.

§lambda_function_schedule_failed_event_details: Option<LambdaFunctionScheduleFailedEventDetails>

Contains details about a failed Lambda function schedule event that occurred during an execution.

§lambda_function_scheduled_event_details: Option<LambdaFunctionScheduledEventDetails>

Contains details about a Lambda function scheduled during an execution.

§lambda_function_start_failed_event_details: Option<LambdaFunctionStartFailedEventDetails>

Contains details about a lambda function that failed to start during an execution.

§lambda_function_succeeded_event_details: Option<LambdaFunctionSucceededEventDetails>

Contains details about a Lambda function that terminated successfully during an execution.

§lambda_function_timed_out_event_details: Option<LambdaFunctionTimedOutEventDetails>

Contains details about a Lambda function timeout that occurred during an execution.

§state_entered_event_details: Option<StateEnteredEventDetails>

Contains details about a state entered during an execution.

§state_exited_event_details: Option<StateExitedEventDetails>

Contains details about an exit from a state during an execution.

§map_run_started_event_details: Option<MapRunStartedEventDetails>

Contains details, such as mapRunArn, and the start date and time of a Map Run. mapRunArn is the Amazon Resource Name (ARN) of the Map Run that was started.

§map_run_failed_event_details: Option<MapRunFailedEventDetails>

Contains error and cause details about a Map Run that failed.

§map_run_redriven_event_details: Option<MapRunRedrivenEventDetails>

Contains details about the redrive attempt of a Map Run.

§evaluation_failed_event_details: Option<EvaluationFailedEventDetails>

Contains details about an evaluation failure that occurred while processing a state.

Implementations§

Source§

impl HistoryEvent

Source

pub fn timestamp(&self) -> &DateTime

The date and time the event occurred.

Source

pub fn type(&self) -> &HistoryEventType

The type of the event.

Source

pub fn id(&self) -> i64

The id of the event. Events are numbered sequentially, starting at one.

Source

pub fn previous_event_id(&self) -> i64

The id of the previous event.

Source

pub fn activity_failed_event_details( &self, ) -> Option<&ActivityFailedEventDetails>

Contains details about an activity that failed during an execution.

Source

pub fn activity_schedule_failed_event_details( &self, ) -> Option<&ActivityScheduleFailedEventDetails>

Contains details about an activity schedule event that failed during an execution.

Source

pub fn activity_scheduled_event_details( &self, ) -> Option<&ActivityScheduledEventDetails>

Contains details about an activity scheduled during an execution.

Source

pub fn activity_started_event_details( &self, ) -> Option<&ActivityStartedEventDetails>

Contains details about the start of an activity during an execution.

Source

pub fn activity_succeeded_event_details( &self, ) -> Option<&ActivitySucceededEventDetails>

Contains details about an activity that successfully terminated during an execution.

Source

pub fn activity_timed_out_event_details( &self, ) -> Option<&ActivityTimedOutEventDetails>

Contains details about an activity timeout that occurred during an execution.

Source

pub fn task_failed_event_details(&self) -> Option<&TaskFailedEventDetails>

Contains details about the failure of a task.

Source

pub fn task_scheduled_event_details(&self) -> Option<&TaskScheduledEventDetails>

Contains details about a task that was scheduled.

Source

pub fn task_start_failed_event_details( &self, ) -> Option<&TaskStartFailedEventDetails>

Contains details about a task that failed to start.

Source

pub fn task_started_event_details(&self) -> Option<&TaskStartedEventDetails>

Contains details about a task that was started.

Source

pub fn task_submit_failed_event_details( &self, ) -> Option<&TaskSubmitFailedEventDetails>

Contains details about a task that where the submit failed.

Source

pub fn task_submitted_event_details(&self) -> Option<&TaskSubmittedEventDetails>

Contains details about a submitted task.

Source

pub fn task_succeeded_event_details(&self) -> Option<&TaskSucceededEventDetails>

Contains details about a task that succeeded.

Source

pub fn task_timed_out_event_details(&self) -> Option<&TaskTimedOutEventDetails>

Contains details about a task that timed out.

Source

pub fn execution_failed_event_details( &self, ) -> Option<&ExecutionFailedEventDetails>

Contains details about an execution failure event.

Source

pub fn execution_started_event_details( &self, ) -> Option<&ExecutionStartedEventDetails>

Contains details about the start of the execution.

Source

pub fn execution_succeeded_event_details( &self, ) -> Option<&ExecutionSucceededEventDetails>

Contains details about the successful termination of the execution.

Source

pub fn execution_aborted_event_details( &self, ) -> Option<&ExecutionAbortedEventDetails>

Contains details about an abort of an execution.

Source

pub fn execution_timed_out_event_details( &self, ) -> Option<&ExecutionTimedOutEventDetails>

Contains details about the execution timeout that occurred during the execution.

Source

pub fn execution_redriven_event_details( &self, ) -> Option<&ExecutionRedrivenEventDetails>

Contains details about the redrive attempt of an execution.

Source

pub fn map_state_started_event_details( &self, ) -> Option<&MapStateStartedEventDetails>

Contains details about Map state that was started.

Source

pub fn map_iteration_started_event_details( &self, ) -> Option<&MapIterationEventDetails>

Contains details about an iteration of a Map state that was started.

Source

pub fn map_iteration_succeeded_event_details( &self, ) -> Option<&MapIterationEventDetails>

Contains details about an iteration of a Map state that succeeded.

Source

pub fn map_iteration_failed_event_details( &self, ) -> Option<&MapIterationEventDetails>

Contains details about an iteration of a Map state that failed.

Source

pub fn map_iteration_aborted_event_details( &self, ) -> Option<&MapIterationEventDetails>

Contains details about an iteration of a Map state that was aborted.

Source

pub fn lambda_function_failed_event_details( &self, ) -> Option<&LambdaFunctionFailedEventDetails>

Contains details about a Lambda function that failed during an execution.

Source

pub fn lambda_function_schedule_failed_event_details( &self, ) -> Option<&LambdaFunctionScheduleFailedEventDetails>

Contains details about a failed Lambda function schedule event that occurred during an execution.

Source

pub fn lambda_function_scheduled_event_details( &self, ) -> Option<&LambdaFunctionScheduledEventDetails>

Contains details about a Lambda function scheduled during an execution.

Source

pub fn lambda_function_start_failed_event_details( &self, ) -> Option<&LambdaFunctionStartFailedEventDetails>

Contains details about a lambda function that failed to start during an execution.

Source

pub fn lambda_function_succeeded_event_details( &self, ) -> Option<&LambdaFunctionSucceededEventDetails>

Contains details about a Lambda function that terminated successfully during an execution.

Source

pub fn lambda_function_timed_out_event_details( &self, ) -> Option<&LambdaFunctionTimedOutEventDetails>

Contains details about a Lambda function timeout that occurred during an execution.

Source

pub fn state_entered_event_details(&self) -> Option<&StateEnteredEventDetails>

Contains details about a state entered during an execution.

Source

pub fn state_exited_event_details(&self) -> Option<&StateExitedEventDetails>

Contains details about an exit from a state during an execution.

Source

pub fn map_run_started_event_details( &self, ) -> Option<&MapRunStartedEventDetails>

Contains details, such as mapRunArn, and the start date and time of a Map Run. mapRunArn is the Amazon Resource Name (ARN) of the Map Run that was started.

Source

pub fn map_run_failed_event_details(&self) -> Option<&MapRunFailedEventDetails>

Contains error and cause details about a Map Run that failed.

Source

pub fn map_run_redriven_event_details( &self, ) -> Option<&MapRunRedrivenEventDetails>

Contains details about the redrive attempt of a Map Run.

Source

pub fn evaluation_failed_event_details( &self, ) -> Option<&EvaluationFailedEventDetails>

Contains details about an evaluation failure that occurred while processing a state.

Source§

impl HistoryEvent

Source

pub fn builder() -> HistoryEventBuilder

Creates a new builder-style object to manufacture HistoryEvent.

Trait Implementations§

Source§

impl Clone for HistoryEvent

Source§

fn clone(&self) -> HistoryEvent

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 HistoryEvent

Source§

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

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

impl PartialEq for HistoryEvent

Source§

fn eq(&self, other: &HistoryEvent) -> 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 HistoryEvent

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,