UtteranceSpecificationBuilder

aws_sdk_lexmodelsv2::types::builders

Struct UtteranceSpecificationBuilder 

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

A builder for UtteranceSpecification.

Implementations§

Source§

impl UtteranceSpecificationBuilder

Source

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

The identifier of the alias of the bot that the utterance was made to.

Source

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

The identifier of the alias of the bot that the utterance was made to.

Source

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

The identifier of the alias of the bot that the utterance was made to.

Source

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

The version of the bot that the utterance was made to.

Source

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

The version of the bot that the utterance was made to.

Source

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

The version of the bot that the utterance was made to.

Source

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

The locale of the bot that the utterance was made to.

Source

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

The locale of the bot that the utterance was made to.

Source

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

The locale of the bot that the utterance was made to.

Source

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

The identifier of the session that the utterance was made in.

Source

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

The identifier of the session that the utterance was made in.

Source

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

The identifier of the session that the utterance was made in.

Source

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

The channel that is integrated with the bot that the utterance was made to.

Source

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

The channel that is integrated with the bot that the utterance was made to.

Source

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

The channel that is integrated with the bot that the utterance was made to.

Source

pub fn mode(self, input: AnalyticsModality) -> Self

The mode of the session. The possible values are as follows:

  • Speech – The session consisted of spoken dialogue.

  • Text – The session consisted of written dialogue.

  • DTMF – The session consisted of touch-tone keypad (Dual Tone Multi-Frequency) key presses.

  • MultiMode – The session consisted of multiple modes.

Source

pub fn set_mode(self, input: Option<AnalyticsModality>) -> Self

The mode of the session. The possible values are as follows:

  • Speech – The session consisted of spoken dialogue.

  • Text – The session consisted of written dialogue.

  • DTMF – The session consisted of touch-tone keypad (Dual Tone Multi-Frequency) key presses.

  • MultiMode – The session consisted of multiple modes.

Source

pub fn get_mode(&self) -> &Option<AnalyticsModality>

The mode of the session. The possible values are as follows:

  • Speech – The session consisted of spoken dialogue.

  • Text – The session consisted of written dialogue.

  • DTMF – The session consisted of touch-tone keypad (Dual Tone Multi-Frequency) key presses.

  • MultiMode – The session consisted of multiple modes.

Source

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

The date and time when the conversation in which the utterance took place began. A conversation is defined as a unique combination of a sessionId and an originatingRequestId.

Source

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

The date and time when the conversation in which the utterance took place began. A conversation is defined as a unique combination of a sessionId and an originatingRequestId.

Source

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

The date and time when the conversation in which the utterance took place began. A conversation is defined as a unique combination of a sessionId and an originatingRequestId.

Source

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

The date and time when the conversation in which the utterance took place ended. A conversation is defined as a unique combination of a sessionId and an originatingRequestId.

Source

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

The date and time when the conversation in which the utterance took place ended. A conversation is defined as a unique combination of a sessionId and an originatingRequestId.

Source

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

The date and time when the conversation in which the utterance took place ended. A conversation is defined as a unique combination of a sessionId and an originatingRequestId.

Source

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

The text of the utterance.

Source

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

The text of the utterance.

Source

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

The text of the utterance.

Source

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

The date and time when the utterance took place.

Source

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

The date and time when the utterance took place.

Source

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

The date and time when the utterance took place.

Source

pub fn audio_voice_duration_millis(self, input: i64) -> Self

The duration in milliseconds of the audio associated with the utterance.

Source

pub fn set_audio_voice_duration_millis(self, input: Option<i64>) -> Self

The duration in milliseconds of the audio associated with the utterance.

Source

pub fn get_audio_voice_duration_millis(&self) -> &Option<i64>

The duration in milliseconds of the audio associated with the utterance.

Source

pub fn utterance_understood(self, input: bool) -> Self

Specifies whether the bot understood the utterance or not.

Source

pub fn set_utterance_understood(self, input: Option<bool>) -> Self

Specifies whether the bot understood the utterance or not.

Source

pub fn get_utterance_understood(&self) -> &Option<bool>

Specifies whether the bot understood the utterance or not.

Source

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

The input type of the utterance. The possible values are as follows:

  • PCM format: audio data must be in little-endian byte order.

    • audio/l16; rate=16000; channels=1

    • audio/x-l16; sample-rate=16000; channel-count=1

    • audio/lpcm; sample-rate=8000; sample-size-bits=16; channel-count=1; is-big-endian=false

  • Opus format

    • audio/x-cbr-opus-with-preamble;preamble-size=0;bit-rate=256000;frame-size-milliseconds=4

  • Text format

    • text/plain; charset=utf-8

Source

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

The input type of the utterance. The possible values are as follows:

  • PCM format: audio data must be in little-endian byte order.

    • audio/l16; rate=16000; channels=1

    • audio/x-l16; sample-rate=16000; channel-count=1

    • audio/lpcm; sample-rate=8000; sample-size-bits=16; channel-count=1; is-big-endian=false

  • Opus format

    • audio/x-cbr-opus-with-preamble;preamble-size=0;bit-rate=256000;frame-size-milliseconds=4

  • Text format

    • text/plain; charset=utf-8

Source

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

The input type of the utterance. The possible values are as follows:

  • PCM format: audio data must be in little-endian byte order.

    • audio/l16; rate=16000; channels=1

    • audio/x-l16; sample-rate=16000; channel-count=1

    • audio/lpcm; sample-rate=8000; sample-size-bits=16; channel-count=1; is-big-endian=false

  • Opus format

    • audio/x-cbr-opus-with-preamble;preamble-size=0;bit-rate=256000;frame-size-milliseconds=4

  • Text format

    • text/plain; charset=utf-8

Source

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

The output type of the utterance. The possible values are as follows:

  • audio/mpeg

  • audio/ogg

  • audio/pcm (16 KHz)

  • audio/ (defaults to mpeg)

  • text/plain; charset=utf-8

Source

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

The output type of the utterance. The possible values are as follows:

  • audio/mpeg

  • audio/ogg

  • audio/pcm (16 KHz)

  • audio/ (defaults to mpeg)

  • text/plain; charset=utf-8

Source

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

The output type of the utterance. The possible values are as follows:

  • audio/mpeg

  • audio/ogg

  • audio/pcm (16 KHz)

  • audio/ (defaults to mpeg)

  • text/plain; charset=utf-8

Source

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

The name of the intent that the utterance is associated to.

Source

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

The name of the intent that the utterance is associated to.

Source

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

The name of the intent that the utterance is associated to.

Source

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

The name of the slot that the utterance is associated to.

Source

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

The name of the slot that the utterance is associated to.

Source

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

The name of the slot that the utterance is associated to.

Source

pub fn intent_state(self, input: IntentState) -> Self

The state of the intent that the utterance is associated to.

Source

pub fn set_intent_state(self, input: Option<IntentState>) -> Self

The state of the intent that the utterance is associated to.

Source

pub fn get_intent_state(&self) -> &Option<IntentState>

The state of the intent that the utterance is associated to.

Source

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

The type of dialog action that the utterance is associated to. See the type field in DialogAction for more information.

Source

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

The type of dialog action that the utterance is associated to. See the type field in DialogAction for more information.

Source

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

The type of dialog action that the utterance is associated to. See the type field in DialogAction for more information.

Source

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

The identifier for the audio of the bot response.

Source

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

The identifier for the audio of the bot response.

Source

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

The identifier for the audio of the bot response.

Source

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

The slots that have been filled in the session by the time of the utterance.

Source

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

The slots that have been filled in the session by the time of the utterance.

Source

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

The slots that have been filled in the session by the time of the utterance.

Source

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

The identifier of the request associated with the utterance.

Source

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

The identifier of the request associated with the utterance.

Source

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

The identifier of the request associated with the utterance.

Source

pub fn bot_responses(self, input: UtteranceBotResponse) -> Self

Appends an item to bot_responses.

To override the contents of this collection use set_bot_responses.

A list of objects containing information about the bot response to the utterance.

Source

pub fn set_bot_responses(self, input: Option<Vec<UtteranceBotResponse>>) -> Self

A list of objects containing information about the bot response to the utterance.

Source

pub fn get_bot_responses(&self) -> &Option<Vec<UtteranceBotResponse>>

A list of objects containing information about the bot response to the utterance.

Source

pub fn build(self) -> UtteranceSpecification

Consumes the builder and constructs a UtteranceSpecification.

Trait Implementations§

Source§

impl Clone for UtteranceSpecificationBuilder

Source§

fn clone(&self) -> UtteranceSpecificationBuilder

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 UtteranceSpecificationBuilder

Source§

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

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

impl Default for UtteranceSpecificationBuilder

Source§

fn default() -> UtteranceSpecificationBuilder

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

impl PartialEq for UtteranceSpecificationBuilder

Source§

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

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,