EventBuilder

aws_sdk_lambda::types::builders

Struct EventBuilder 

Source 
#[non_exhaustive]
pub struct EventBuilder { /* private fields */ }
Expand description

A builder for Event.

Implementations§

Source§

impl EventBuilder

Source

pub fn event_type(self, input: EventType) -> Self

The type of event that occurred.

Source

pub fn set_event_type(self, input: Option<EventType>) -> Self

The type of event that occurred.

Source

pub fn get_event_type(&self) -> &Option<EventType>

The type of event that occurred.

Source

pub fn sub_type(self, input: impl Into<String>) -> Self

The subtype of the event, providing additional categorization.

Source

pub fn set_sub_type(self, input: Option<String>) -> Self

The subtype of the event, providing additional categorization.

Source

pub fn get_sub_type(&self) -> &Option<String>

The subtype of the event, providing additional categorization.

Source

pub fn event_id(self, input: i32) -> Self

The unique identifier for this event. Event IDs increment sequentially.

Source

pub fn set_event_id(self, input: Option<i32>) -> Self

The unique identifier for this event. Event IDs increment sequentially.

Source

pub fn get_event_id(&self) -> &Option<i32>

The unique identifier for this event. Event IDs increment sequentially.

Source

pub fn id(self, input: impl Into<String>) -> Self

The unique identifier for this operation.

Source

pub fn set_id(self, input: Option<String>) -> Self

The unique identifier for this operation.

Source

pub fn get_id(&self) -> &Option<String>

The unique identifier for this operation.

Source

pub fn name(self, input: impl Into<String>) -> Self

The customer-provided name for this operation.

Source

pub fn set_name(self, input: Option<String>) -> Self

The customer-provided name for this operation.

Source

pub fn get_name(&self) -> &Option<String>

The customer-provided name for this operation.

Source

pub fn event_timestamp(self, input: DateTime) -> Self

The date and time when this event occurred, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

Source

pub fn set_event_timestamp(self, input: Option<DateTime>) -> Self

The date and time when this event occurred, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

Source

pub fn get_event_timestamp(&self) -> &Option<DateTime>

The date and time when this event occurred, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

Source

pub fn parent_id(self, input: impl Into<String>) -> Self

The unique identifier of the parent operation, if this operation is running within a child context.

Source

pub fn set_parent_id(self, input: Option<String>) -> Self

The unique identifier of the parent operation, if this operation is running within a child context.

Source

pub fn get_parent_id(&self) -> &Option<String>

The unique identifier of the parent operation, if this operation is running within a child context.

Source

pub fn execution_started_details(self, input: ExecutionStartedDetails) -> Self

Details about an execution that started.

Source

pub fn set_execution_started_details( self, input: Option<ExecutionStartedDetails>, ) -> Self

Details about an execution that started.

Source

pub fn get_execution_started_details(&self) -> &Option<ExecutionStartedDetails>

Details about an execution that started.

Source

pub fn execution_succeeded_details( self, input: ExecutionSucceededDetails, ) -> Self

Details about an execution that succeeded.

Source

pub fn set_execution_succeeded_details( self, input: Option<ExecutionSucceededDetails>, ) -> Self

Details about an execution that succeeded.

Source

pub fn get_execution_succeeded_details( &self, ) -> &Option<ExecutionSucceededDetails>

Details about an execution that succeeded.

Source

pub fn execution_failed_details(self, input: ExecutionFailedDetails) -> Self

Details about an execution that failed.

Source

pub fn set_execution_failed_details( self, input: Option<ExecutionFailedDetails>, ) -> Self

Details about an execution that failed.

Source

pub fn get_execution_failed_details(&self) -> &Option<ExecutionFailedDetails>

Details about an execution that failed.

Source

pub fn execution_timed_out_details( self, input: ExecutionTimedOutDetails, ) -> Self

Details about an execution that timed out.

Source

pub fn set_execution_timed_out_details( self, input: Option<ExecutionTimedOutDetails>, ) -> Self

Details about an execution that timed out.

Source

pub fn get_execution_timed_out_details( &self, ) -> &Option<ExecutionTimedOutDetails>

Details about an execution that timed out.

Source

pub fn execution_stopped_details(self, input: ExecutionStoppedDetails) -> Self

Details about an execution that was stopped.

Source

pub fn set_execution_stopped_details( self, input: Option<ExecutionStoppedDetails>, ) -> Self

Details about an execution that was stopped.

Source

pub fn get_execution_stopped_details(&self) -> &Option<ExecutionStoppedDetails>

Details about an execution that was stopped.

Source

pub fn context_started_details(self, input: ContextStartedDetails) -> Self

Details about a context that started.

Source

pub fn set_context_started_details( self, input: Option<ContextStartedDetails>, ) -> Self

Details about a context that started.

Source

pub fn get_context_started_details(&self) -> &Option<ContextStartedDetails>

Details about a context that started.

Source

pub fn context_succeeded_details(self, input: ContextSucceededDetails) -> Self

Details about a context that succeeded.

Source

pub fn set_context_succeeded_details( self, input: Option<ContextSucceededDetails>, ) -> Self

Details about a context that succeeded.

Source

pub fn get_context_succeeded_details(&self) -> &Option<ContextSucceededDetails>

Details about a context that succeeded.

Source

pub fn context_failed_details(self, input: ContextFailedDetails) -> Self

Details about a context that failed.

Source

pub fn set_context_failed_details( self, input: Option<ContextFailedDetails>, ) -> Self

Details about a context that failed.

Source

pub fn get_context_failed_details(&self) -> &Option<ContextFailedDetails>

Details about a context that failed.

Source

pub fn wait_started_details(self, input: WaitStartedDetails) -> Self

Details about a wait operation that started.

Source

pub fn set_wait_started_details(self, input: Option<WaitStartedDetails>) -> Self

Details about a wait operation that started.

Source

pub fn get_wait_started_details(&self) -> &Option<WaitStartedDetails>

Details about a wait operation that started.

Source

pub fn wait_succeeded_details(self, input: WaitSucceededDetails) -> Self

Details about a wait operation that succeeded.

Source

pub fn set_wait_succeeded_details( self, input: Option<WaitSucceededDetails>, ) -> Self

Details about a wait operation that succeeded.

Source

pub fn get_wait_succeeded_details(&self) -> &Option<WaitSucceededDetails>

Details about a wait operation that succeeded.

Source

pub fn wait_cancelled_details(self, input: WaitCancelledDetails) -> Self

Details about a wait operation that was cancelled.

Source

pub fn set_wait_cancelled_details( self, input: Option<WaitCancelledDetails>, ) -> Self

Details about a wait operation that was cancelled.

Source

pub fn get_wait_cancelled_details(&self) -> &Option<WaitCancelledDetails>

Details about a wait operation that was cancelled.

Source

pub fn step_started_details(self, input: StepStartedDetails) -> Self

Details about a step that started.

Source

pub fn set_step_started_details(self, input: Option<StepStartedDetails>) -> Self

Details about a step that started.

Source

pub fn get_step_started_details(&self) -> &Option<StepStartedDetails>

Details about a step that started.

Source

pub fn step_succeeded_details(self, input: StepSucceededDetails) -> Self

Details about a step that succeeded.

Source

pub fn set_step_succeeded_details( self, input: Option<StepSucceededDetails>, ) -> Self

Details about a step that succeeded.

Source

pub fn get_step_succeeded_details(&self) -> &Option<StepSucceededDetails>

Details about a step that succeeded.

Source

pub fn step_failed_details(self, input: StepFailedDetails) -> Self

Details about a step that failed.

Source

pub fn set_step_failed_details(self, input: Option<StepFailedDetails>) -> Self

Details about a step that failed.

Source

pub fn get_step_failed_details(&self) -> &Option<StepFailedDetails>

Details about a step that failed.

Source

pub fn chained_invoke_started_details( self, input: ChainedInvokeStartedDetails, ) -> Self

Contains details about a chained function invocation that has started execution, including start time and execution context.

Source

pub fn set_chained_invoke_started_details( self, input: Option<ChainedInvokeStartedDetails>, ) -> Self

Contains details about a chained function invocation that has started execution, including start time and execution context.

Source

pub fn get_chained_invoke_started_details( &self, ) -> &Option<ChainedInvokeStartedDetails>

Contains details about a chained function invocation that has started execution, including start time and execution context.

Source

pub fn chained_invoke_succeeded_details( self, input: ChainedInvokeSucceededDetails, ) -> Self

Details about a chained invocation that succeeded.

Source

pub fn set_chained_invoke_succeeded_details( self, input: Option<ChainedInvokeSucceededDetails>, ) -> Self

Details about a chained invocation that succeeded.

Source

pub fn get_chained_invoke_succeeded_details( &self, ) -> &Option<ChainedInvokeSucceededDetails>

Details about a chained invocation that succeeded.

Source

pub fn chained_invoke_failed_details( self, input: ChainedInvokeFailedDetails, ) -> Self

Contains details about a failed chained function invocation, including error information and failure reason.

Source

pub fn set_chained_invoke_failed_details( self, input: Option<ChainedInvokeFailedDetails>, ) -> Self

Contains details about a failed chained function invocation, including error information and failure reason.

Source

pub fn get_chained_invoke_failed_details( &self, ) -> &Option<ChainedInvokeFailedDetails>

Contains details about a failed chained function invocation, including error information and failure reason.

Source

pub fn chained_invoke_timed_out_details( self, input: ChainedInvokeTimedOutDetails, ) -> Self

Details about a chained invocation that timed out.

Source

pub fn set_chained_invoke_timed_out_details( self, input: Option<ChainedInvokeTimedOutDetails>, ) -> Self

Details about a chained invocation that timed out.

Source

pub fn get_chained_invoke_timed_out_details( &self, ) -> &Option<ChainedInvokeTimedOutDetails>

Details about a chained invocation that timed out.

Source

pub fn chained_invoke_stopped_details( self, input: ChainedInvokeStoppedDetails, ) -> Self

Details about a chained invocation that was stopped.

Source

pub fn set_chained_invoke_stopped_details( self, input: Option<ChainedInvokeStoppedDetails>, ) -> Self

Details about a chained invocation that was stopped.

Source

pub fn get_chained_invoke_stopped_details( &self, ) -> &Option<ChainedInvokeStoppedDetails>

Details about a chained invocation that was stopped.

Source

pub fn callback_started_details(self, input: CallbackStartedDetails) -> Self

Contains details about a callback operation that has started, including timing information and callback metadata.

Source

pub fn set_callback_started_details( self, input: Option<CallbackStartedDetails>, ) -> Self

Contains details about a callback operation that has started, including timing information and callback metadata.

Source

pub fn get_callback_started_details(&self) -> &Option<CallbackStartedDetails>

Contains details about a callback operation that has started, including timing information and callback metadata.

Source

pub fn callback_succeeded_details(self, input: CallbackSucceededDetails) -> Self

Contains details about a successfully completed callback operation, including the result data and completion timestamp.

Source

pub fn set_callback_succeeded_details( self, input: Option<CallbackSucceededDetails>, ) -> Self

Contains details about a successfully completed callback operation, including the result data and completion timestamp.

Source

pub fn get_callback_succeeded_details( &self, ) -> &Option<CallbackSucceededDetails>

Contains details about a successfully completed callback operation, including the result data and completion timestamp.

Source

pub fn callback_failed_details(self, input: CallbackFailedDetails) -> Self

Contains details about a failed callback operation, including error information and the reason for failure.

Source

pub fn set_callback_failed_details( self, input: Option<CallbackFailedDetails>, ) -> Self

Contains details about a failed callback operation, including error information and the reason for failure.

Source

pub fn get_callback_failed_details(&self) -> &Option<CallbackFailedDetails>

Contains details about a failed callback operation, including error information and the reason for failure.

Source

pub fn callback_timed_out_details(self, input: CallbackTimedOutDetails) -> Self

Contains details about a callback operation that timed out, including timeout duration and any partial results.

Source

pub fn set_callback_timed_out_details( self, input: Option<CallbackTimedOutDetails>, ) -> Self

Contains details about a callback operation that timed out, including timeout duration and any partial results.

Source

pub fn get_callback_timed_out_details(&self) -> &Option<CallbackTimedOutDetails>

Contains details about a callback operation that timed out, including timeout duration and any partial results.

Source

pub fn invocation_completed_details( self, input: InvocationCompletedDetails, ) -> Self

Details about a function invocation that completed.

Source

pub fn set_invocation_completed_details( self, input: Option<InvocationCompletedDetails>, ) -> Self

Details about a function invocation that completed.

Source

pub fn get_invocation_completed_details( &self, ) -> &Option<InvocationCompletedDetails>

Details about a function invocation that completed.

Source

pub fn build(self) -> Event

Consumes the builder and constructs a Event.

Trait Implementations§

Source§

impl Clone for EventBuilder

Source§

fn clone(&self) -> EventBuilder

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 EventBuilder

Source§

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

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

impl Default for EventBuilder

Source§

fn default() -> EventBuilder

Returns the “default value” for a type. Read more
Source§

impl PartialEq for EventBuilder

Source§

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

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