InvokeInlineAgentInputBuilder

aws_sdk_bedrockagentruntime::operation::invoke_inline_agent::builders

Struct InvokeInlineAgentInputBuilder 

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

A builder for InvokeInlineAgentInput.

Implementations§

Source§

impl InvokeInlineAgentInputBuilder

Source

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

The Amazon Resource Name (ARN) of the Amazon Web Services KMS key to use to encrypt your inline agent.

Source

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

The Amazon Resource Name (ARN) of the Amazon Web Services KMS key to use to encrypt your inline agent.

Source

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

The Amazon Resource Name (ARN) of the Amazon Web Services KMS key to use to encrypt your inline agent.

Source

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

The model identifier (ID) of the model to use for orchestration by the inline agent. For example, meta.llama3-1-70b-instruct-v1:0.

This field is required.
Source

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

The model identifier (ID) of the model to use for orchestration by the inline agent. For example, meta.llama3-1-70b-instruct-v1:0.

Source

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

The model identifier (ID) of the model to use for orchestration by the inline agent. For example, meta.llama3-1-70b-instruct-v1:0.

Source

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

The instructions that tell the inline agent what it should do and how it should interact with users.

This field is required.
Source

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

The instructions that tell the inline agent what it should do and how it should interact with users.

Source

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

The instructions that tell the inline agent what it should do and how it should interact with users.

Source

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

The number of seconds for which the inline agent should maintain session information. After this time expires, the subsequent InvokeInlineAgent request begins a new session.

A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and the data provided before the timeout is deleted.

Source

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

The number of seconds for which the inline agent should maintain session information. After this time expires, the subsequent InvokeInlineAgent request begins a new session.

A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and the data provided before the timeout is deleted.

Source

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

The number of seconds for which the inline agent should maintain session information. After this time expires, the subsequent InvokeInlineAgent request begins a new session.

A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and the data provided before the timeout is deleted.

Source

pub fn action_groups(self, input: AgentActionGroup) -> Self

Appends an item to action_groups.

To override the contents of this collection use set_action_groups.

A list of action groups with each action group defining the action the inline agent needs to carry out.

Source

pub fn set_action_groups(self, input: Option<Vec<AgentActionGroup>>) -> Self

A list of action groups with each action group defining the action the inline agent needs to carry out.

Source

pub fn get_action_groups(&self) -> &Option<Vec<AgentActionGroup>>

A list of action groups with each action group defining the action the inline agent needs to carry out.

Source

pub fn knowledge_bases(self, input: KnowledgeBase) -> Self

Appends an item to knowledge_bases.

To override the contents of this collection use set_knowledge_bases.

Contains information of the knowledge bases to associate with.

Source

pub fn set_knowledge_bases(self, input: Option<Vec<KnowledgeBase>>) -> Self

Contains information of the knowledge bases to associate with.

Source

pub fn get_knowledge_bases(&self) -> &Option<Vec<KnowledgeBase>>

Contains information of the knowledge bases to associate with.

Source

pub fn guardrail_configuration( self, input: GuardrailConfigurationWithArn, ) -> Self

The guardrails to assign to the inline agent.

Source

pub fn set_guardrail_configuration( self, input: Option<GuardrailConfigurationWithArn>, ) -> Self

The guardrails to assign to the inline agent.

Source

pub fn get_guardrail_configuration( &self, ) -> &Option<GuardrailConfigurationWithArn>

The guardrails to assign to the inline agent.

Source

pub fn prompt_override_configuration( self, input: PromptOverrideConfiguration, ) -> Self

Configurations for advanced prompts used to override the default prompts to enhance the accuracy of the inline agent.

Source

pub fn set_prompt_override_configuration( self, input: Option<PromptOverrideConfiguration>, ) -> Self

Configurations for advanced prompts used to override the default prompts to enhance the accuracy of the inline agent.

Source

pub fn get_prompt_override_configuration( &self, ) -> &Option<PromptOverrideConfiguration>

Configurations for advanced prompts used to override the default prompts to enhance the accuracy of the inline agent.

Source

pub fn agent_collaboration(self, input: AgentCollaboration) -> Self

Defines how the inline collaborator agent handles information across multiple collaborator agents to coordinate a final response. The inline collaborator agent can also be the supervisor.

Source

pub fn set_agent_collaboration(self, input: Option<AgentCollaboration>) -> Self

Defines how the inline collaborator agent handles information across multiple collaborator agents to coordinate a final response. The inline collaborator agent can also be the supervisor.

Source

pub fn get_agent_collaboration(&self) -> &Option<AgentCollaboration>

Defines how the inline collaborator agent handles information across multiple collaborator agents to coordinate a final response. The inline collaborator agent can also be the supervisor.

Source

pub fn collaborator_configurations( self, input: CollaboratorConfiguration, ) -> Self

Appends an item to collaborator_configurations.

To override the contents of this collection use set_collaborator_configurations.

Settings for an inline agent collaborator called with InvokeInlineAgent.

Source

pub fn set_collaborator_configurations( self, input: Option<Vec<CollaboratorConfiguration>>, ) -> Self

Settings for an inline agent collaborator called with InvokeInlineAgent.

Source

pub fn get_collaborator_configurations( &self, ) -> &Option<Vec<CollaboratorConfiguration>>

Settings for an inline agent collaborator called with InvokeInlineAgent.

Source

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

The name for the agent.

Source

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

The name for the agent.

Source

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

The name for the agent.

Source

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

The unique identifier of the session. Use the same value across requests to continue the same conversation.

This field is required.
Source

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

The unique identifier of the session. Use the same value across requests to continue the same conversation.

Source

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

The unique identifier of the session. Use the same value across requests to continue the same conversation.

Source

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

Specifies whether to end the session with the inline agent or not.

Source

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

Specifies whether to end the session with the inline agent or not.

Source

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

Specifies whether to end the session with the inline agent or not.

Source

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

Specifies whether to turn on the trace or not to track the agent's reasoning process. For more information, see Using trace.

Source

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

Specifies whether to turn on the trace or not to track the agent's reasoning process. For more information, see Using trace.

Source

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

Specifies whether to turn on the trace or not to track the agent's reasoning process. For more information, see Using trace.

Source

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

The prompt text to send to the agent.

If you include returnControlInvocationResults in the sessionState field, the inputText field will be ignored.

Source

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

The prompt text to send to the agent.

If you include returnControlInvocationResults in the sessionState field, the inputText field will be ignored.

Source

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

The prompt text to send to the agent.

If you include returnControlInvocationResults in the sessionState field, the inputText field will be ignored.

Source

pub fn streaming_configurations(self, input: StreamingConfigurations) -> Self

Specifies the configurations for streaming.

To use agent streaming, you need permissions to perform the bedrock:InvokeModelWithResponseStream action.

Source

pub fn set_streaming_configurations( self, input: Option<StreamingConfigurations>, ) -> Self

Specifies the configurations for streaming.

To use agent streaming, you need permissions to perform the bedrock:InvokeModelWithResponseStream action.

Source

pub fn get_streaming_configurations(&self) -> &Option<StreamingConfigurations>

Specifies the configurations for streaming.

To use agent streaming, you need permissions to perform the bedrock:InvokeModelWithResponseStream action.

Source

pub fn prompt_creation_configurations( self, input: PromptCreationConfigurations, ) -> Self

Specifies parameters that control how the service populates the agent prompt for an InvokeInlineAgent request. You can control which aspects of previous invocations in the same agent session the service uses to populate the agent prompt. This gives you more granular control over the contextual history that is used to process the current request.

Source

pub fn set_prompt_creation_configurations( self, input: Option<PromptCreationConfigurations>, ) -> Self

Specifies parameters that control how the service populates the agent prompt for an InvokeInlineAgent request. You can control which aspects of previous invocations in the same agent session the service uses to populate the agent prompt. This gives you more granular control over the contextual history that is used to process the current request.

Source

pub fn get_prompt_creation_configurations( &self, ) -> &Option<PromptCreationConfigurations>

Specifies parameters that control how the service populates the agent prompt for an InvokeInlineAgent request. You can control which aspects of previous invocations in the same agent session the service uses to populate the agent prompt. This gives you more granular control over the contextual history that is used to process the current request.

Source

pub fn inline_session_state(self, input: InlineSessionState) -> Self

Parameters that specify the various attributes of a sessions. You can include attributes for the session or prompt or, if you configured an action group to return control, results from invocation of the action group. For more information, see Control session context.

If you include returnControlInvocationResults in the sessionState field, the inputText field will be ignored.

Source

pub fn set_inline_session_state(self, input: Option<InlineSessionState>) -> Self

Parameters that specify the various attributes of a sessions. You can include attributes for the session or prompt or, if you configured an action group to return control, results from invocation of the action group. For more information, see Control session context.

If you include returnControlInvocationResults in the sessionState field, the inputText field will be ignored.

Source

pub fn get_inline_session_state(&self) -> &Option<InlineSessionState>

Parameters that specify the various attributes of a sessions. You can include attributes for the session or prompt or, if you configured an action group to return control, results from invocation of the action group. For more information, see Control session context.

If you include returnControlInvocationResults in the sessionState field, the inputText field will be ignored.

Source

pub fn collaborators(self, input: Collaborator) -> Self

Appends an item to collaborators.

To override the contents of this collection use set_collaborators.

List of collaborator inline agents.

Source

pub fn set_collaborators(self, input: Option<Vec<Collaborator>>) -> Self

List of collaborator inline agents.

Source

pub fn get_collaborators(&self) -> &Option<Vec<Collaborator>>

List of collaborator inline agents.

Source

pub fn bedrock_model_configurations( self, input: InlineBedrockModelConfigurations, ) -> Self

Model settings for the request.

Source

pub fn set_bedrock_model_configurations( self, input: Option<InlineBedrockModelConfigurations>, ) -> Self

Model settings for the request.

Source

pub fn get_bedrock_model_configurations( &self, ) -> &Option<InlineBedrockModelConfigurations>

Model settings for the request.

Source

pub fn orchestration_type(self, input: OrchestrationType) -> Self

Specifies the type of orchestration strategy for the agent. This is set to DEFAULT orchestration type, by default.

Source

pub fn set_orchestration_type(self, input: Option<OrchestrationType>) -> Self

Specifies the type of orchestration strategy for the agent. This is set to DEFAULT orchestration type, by default.

Source

pub fn get_orchestration_type(&self) -> &Option<OrchestrationType>

Specifies the type of orchestration strategy for the agent. This is set to DEFAULT orchestration type, by default.

Source

pub fn custom_orchestration(self, input: CustomOrchestration) -> Self

Contains details of the custom orchestration configured for the agent.

Source

pub fn set_custom_orchestration( self, input: Option<CustomOrchestration>, ) -> Self

Contains details of the custom orchestration configured for the agent.

Source

pub fn get_custom_orchestration(&self) -> &Option<CustomOrchestration>

Contains details of the custom orchestration configured for the agent.

Source

pub fn build(self) -> Result<InvokeInlineAgentInput, BuildError>

Consumes the builder and constructs a InvokeInlineAgentInput.

Source§

impl InvokeInlineAgentInputBuilder

Source

pub async fn send_with( self, client: &Client, ) -> Result<InvokeInlineAgentOutput, SdkError<InvokeInlineAgentError, HttpResponse>>

Sends a request with this input using the given client.

Trait Implementations§

Source§

impl Clone for InvokeInlineAgentInputBuilder

Source§

fn clone(&self) -> InvokeInlineAgentInputBuilder

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 InvokeInlineAgentInputBuilder

Source§

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

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

impl Default for InvokeInlineAgentInputBuilder

Source§

fn default() -> InvokeInlineAgentInputBuilder

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

impl PartialEq for InvokeInlineAgentInputBuilder

Source§

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

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,