BranchBuilder

aws_sdk_amplify::types::builders

Struct BranchBuilder 

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

A builder for Branch.

Implementations§

Source§

impl BranchBuilder

Source

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

The Amazon Resource Name (ARN) for a branch that is part of an Amplify app.

This field is required.
Source

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

The Amazon Resource Name (ARN) for a branch that is part of an Amplify app.

Source

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

The Amazon Resource Name (ARN) for a branch that is part of an Amplify app.

Source

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

The name for the branch that is part of an Amplify app.

This field is required.
Source

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

The name for the branch that is part of an Amplify app.

Source

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

The name for the branch that is part of an Amplify app.

Source

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

The description for the branch that is part of an Amplify app.

This field is required.
Source

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

The description for the branch that is part of an Amplify app.

Source

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

The description for the branch that is part of an Amplify app.

Source

pub fn tags(self, k: impl Into<String>, v: impl Into<String>) -> Self

Adds a key-value pair to tags.

To override the contents of this collection use set_tags.

The tag for the branch of an Amplify app.

Source

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

The tag for the branch of an Amplify app.

Source

pub fn get_tags(&self) -> &Option<HashMap<String, String>>

The tag for the branch of an Amplify app.

Source

pub fn stage(self, input: Stage) -> Self

The current stage for the branch that is part of an Amplify app.

This field is required.
Source

pub fn set_stage(self, input: Option<Stage>) -> Self

The current stage for the branch that is part of an Amplify app.

Source

pub fn get_stage(&self) -> &Option<Stage>

The current stage for the branch that is part of an Amplify app.

Source

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

The display name for the branch. This is used as the default domain prefix.

This field is required.
Source

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

The display name for the branch. This is used as the default domain prefix.

Source

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

The display name for the branch. This is used as the default domain prefix.

Source

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

Enables notifications for a branch that is part of an Amplify app.

This field is required.
Source

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

Enables notifications for a branch that is part of an Amplify app.

Source

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

Enables notifications for a branch that is part of an Amplify app.

Source

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

A timestamp of when Amplify created the branch.

This field is required.
Source

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

A timestamp of when Amplify created the branch.

Source

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

A timestamp of when Amplify created the branch.

Source

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

A timestamp for the last updated time for a branch.

This field is required.
Source

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

A timestamp for the last updated time for a branch.

Source

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

A timestamp for the last updated time for a branch.

Source

pub fn environment_variables( self, k: impl Into<String>, v: impl Into<String>, ) -> Self

Adds a key-value pair to environment_variables.

To override the contents of this collection use set_environment_variables.

The environment variables specific to a branch of an Amplify app.

Source

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

The environment variables specific to a branch of an Amplify app.

Source

pub fn get_environment_variables(&self) -> &Option<HashMap<String, String>>

The environment variables specific to a branch of an Amplify app.

Source

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

Enables auto-building on push for a branch of an Amplify app.

This field is required.
Source

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

Enables auto-building on push for a branch of an Amplify app.

Source

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

Enables auto-building on push for a branch of an Amplify app.

Source

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

Specifies whether the skew protection feature is enabled for the branch.

Deployment skew protection is available to Amplify applications to eliminate version skew issues between client and servers in web applications. When you apply skew protection to a branch, you can ensure that your clients always interact with the correct version of server-side assets, regardless of when a deployment occurs. For more information about skew protection, see Skew protection for Amplify deployments in the Amplify User Guide.

Source

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

Specifies whether the skew protection feature is enabled for the branch.

Deployment skew protection is available to Amplify applications to eliminate version skew issues between client and servers in web applications. When you apply skew protection to a branch, you can ensure that your clients always interact with the correct version of server-side assets, regardless of when a deployment occurs. For more information about skew protection, see Skew protection for Amplify deployments in the Amplify User Guide.

Source

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

Specifies whether the skew protection feature is enabled for the branch.

Deployment skew protection is available to Amplify applications to eliminate version skew issues between client and servers in web applications. When you apply skew protection to a branch, you can ensure that your clients always interact with the correct version of server-side assets, regardless of when a deployment occurs. For more information about skew protection, see Skew protection for Amplify deployments in the Amplify User Guide.

Source

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

Appends an item to custom_domains.

To override the contents of this collection use set_custom_domains.

The custom domains for a branch of an Amplify app.

Source

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

The custom domains for a branch of an Amplify app.

Source

pub fn get_custom_domains(&self) -> &Option<Vec<String>>

The custom domains for a branch of an Amplify app.

Source

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

The framework for a branch of an Amplify app.

This field is required.
Source

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

The framework for a branch of an Amplify app.

Source

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

The framework for a branch of an Amplify app.

Source

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

The ID of the active job for a branch of an Amplify app.

This field is required.
Source

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

The ID of the active job for a branch of an Amplify app.

Source

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

The ID of the active job for a branch of an Amplify app.

Source

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

The total number of jobs that are part of an Amplify app.

This field is required.
Source

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

The total number of jobs that are part of an Amplify app.

Source

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

The total number of jobs that are part of an Amplify app.

Source

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

Enables basic authorization for a branch of an Amplify app.

This field is required.
Source

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

Enables basic authorization for a branch of an Amplify app.

Source

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

Enables basic authorization for a branch of an Amplify app.

Source

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

Enables performance mode for the branch.

Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out.

Source

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

Enables performance mode for the branch.

Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out.

Source

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

Enables performance mode for the branch.

Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out.

Source

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

The thumbnail URL for the branch of an Amplify app.

Source

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

The thumbnail URL for the branch of an Amplify app.

Source

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

The thumbnail URL for the branch of an Amplify app.

Source

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

The basic authorization credentials for a branch of an Amplify app. You must base64-encode the authorization credentials and provide them in the format user:password.

Source

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

The basic authorization credentials for a branch of an Amplify app. You must base64-encode the authorization credentials and provide them in the format user:password.

Source

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

The basic authorization credentials for a branch of an Amplify app. You must base64-encode the authorization credentials and provide them in the format user:password.

Source

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

The build specification (build spec) content for the branch of an Amplify app.

Source

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

The build specification (build spec) content for the branch of an Amplify app.

Source

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

The build specification (build spec) content for the branch of an Amplify app.

Source

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

The content Time to Live (TTL) for the website in seconds.

This field is required.
Source

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

The content Time to Live (TTL) for the website in seconds.

Source

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

The content Time to Live (TTL) for the website in seconds.

Source

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

Appends an item to associated_resources.

To override the contents of this collection use set_associated_resources.

A list of custom resources that are linked to this branch.

Source

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

A list of custom resources that are linked to this branch.

Source

pub fn get_associated_resources(&self) -> &Option<Vec<String>>

A list of custom resources that are linked to this branch.

Source

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

Enables pull request previews for the branch.

This field is required.
Source

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

Enables pull request previews for the branch.

Source

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

Enables pull request previews for the branch.

Source

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

The Amplify environment name for the pull request.

Source

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

The Amplify environment name for the pull request.

Source

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

The Amplify environment name for the pull request.

Source

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

The destination branch if the branch is a pull request branch.

Source

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

The destination branch if the branch is a pull request branch.

Source

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

The destination branch if the branch is a pull request branch.

Source

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

The source branch if the branch is a pull request branch.

Source

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

The source branch if the branch is a pull request branch.

Source

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

The source branch if the branch is a pull request branch.

Source

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

The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app.

This property is available to Amplify Gen 1 apps only. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.

Source

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

The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app.

This property is available to Amplify Gen 1 apps only. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.

Source

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

The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app.

This property is available to Amplify Gen 1 apps only. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.

Source

pub fn backend(self, input: Backend) -> Self

Describes the backend associated with an Amplify Branch.

This property is available to Amplify Gen 2 apps only. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.

Source

pub fn set_backend(self, input: Option<Backend>) -> Self

Describes the backend associated with an Amplify Branch.

This property is available to Amplify Gen 2 apps only. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.

Source

pub fn get_backend(&self) -> &Option<Backend>

Describes the backend associated with an Amplify Branch.

This property is available to Amplify Gen 2 apps only. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.

Source

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

The Amazon Resource Name (ARN) of the IAM role for a branch of an SSR app. The Compute role allows the Amplify Hosting compute service to securely access specific Amazon Web Services resources based on the role's permissions. For more information about the SSR Compute role, see Adding an SSR Compute role in the Amplify User Guide.

Source

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

The Amazon Resource Name (ARN) of the IAM role for a branch of an SSR app. The Compute role allows the Amplify Hosting compute service to securely access specific Amazon Web Services resources based on the role's permissions. For more information about the SSR Compute role, see Adding an SSR Compute role in the Amplify User Guide.

Source

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

The Amazon Resource Name (ARN) of the IAM role for a branch of an SSR app. The Compute role allows the Amplify Hosting compute service to securely access specific Amazon Web Services resources based on the role's permissions. For more information about the SSR Compute role, see Adding an SSR Compute role in the Amplify User Guide.

Source

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

Consumes the builder and constructs a Branch. This method will fail if any of the following fields are not set:

Trait Implementations§

Source§

impl Clone for BranchBuilder

Source§

fn clone(&self) -> BranchBuilder

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 BranchBuilder

Source§

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

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

impl Default for BranchBuilder

Source§

fn default() -> BranchBuilder

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

impl PartialEq for BranchBuilder

Source§

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

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,