AppBuilder

aws_sdk_amplify::types::builders

Struct AppBuilder 

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

A builder for App.

Implementations§

Source§

impl AppBuilder

Source

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

The unique ID of the Amplify app.

This field is required.
Source

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

The unique ID of the Amplify app.

Source

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

The unique ID of the Amplify app.

Source

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

The Amazon Resource Name (ARN) of the Amplify app.

This field is required.
Source

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

The Amazon Resource Name (ARN) of the Amplify app.

Source

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

The Amazon Resource Name (ARN) of the Amplify app.

Source

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

The name for the Amplify app.

This field is required.
Source

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

The name for the Amplify app.

Source

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

The name for the 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 Amplify app.

Source

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

The tag for the Amplify app.

Source

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

The tag for the Amplify app.

Source

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

The description for the Amplify app.

This field is required.
Source

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

The description for the Amplify app.

Source

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

The description for the Amplify app.

Source

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

The Git repository for the Amplify app.

This field is required.
Source

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

The Git repository for the Amplify app.

Source

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

The Git repository for the Amplify app.

Source

pub fn platform(self, input: Platform) -> Self

The platform for the Amplify app. For a static app, set the platform type to WEB. For a dynamic server-side rendered (SSR) app, set the platform type to WEB_COMPUTE. For an app requiring Amplify Hosting's original SSR support only, set the platform type to WEB_DYNAMIC.

If you are deploying an SSG only app with Next.js 14 or later, you must use the platform type WEB_COMPUTE.

This field is required.
Source

pub fn set_platform(self, input: Option<Platform>) -> Self

The platform for the Amplify app. For a static app, set the platform type to WEB. For a dynamic server-side rendered (SSR) app, set the platform type to WEB_COMPUTE. For an app requiring Amplify Hosting's original SSR support only, set the platform type to WEB_DYNAMIC.

If you are deploying an SSG only app with Next.js 14 or later, you must use the platform type WEB_COMPUTE.

Source

pub fn get_platform(&self) -> &Option<Platform>

The platform for the Amplify app. For a static app, set the platform type to WEB. For a dynamic server-side rendered (SSR) app, set the platform type to WEB_COMPUTE. For an app requiring Amplify Hosting's original SSR support only, set the platform type to WEB_DYNAMIC.

If you are deploying an SSG only app with Next.js 14 or later, you must use the platform type WEB_COMPUTE.

Source

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

A timestamp of when Amplify created the application.

This field is required.
Source

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

A timestamp of when Amplify created the application.

Source

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

A timestamp of when Amplify created the application.

Source

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

A timestamp of when Amplify updated the application.

This field is required.
Source

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

A timestamp of when Amplify updated the application.

Source

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

A timestamp of when Amplify updated the application.

Source

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

The Amazon Resource Name (ARN) of the IAM role for 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 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 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 iam_service_role_arn(self, input: impl Into<String>) -> Self

The Amazon Resource Name (ARN) of the IAM service role for the Amplify app.

Source

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

The Amazon Resource Name (ARN) of the IAM service role for the Amplify app.

Source

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

The Amazon Resource Name (ARN) of the IAM service role for the Amplify app.

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 for the Amplify app.

For a list of the environment variables that are accessible to Amplify by default, see Amplify Environment variables in the Amplify Hosting User Guide.

Source

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

The environment variables for the Amplify app.

For a list of the environment variables that are accessible to Amplify by default, see Amplify Environment variables in the Amplify Hosting User Guide.

Source

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

The environment variables for the Amplify app.

For a list of the environment variables that are accessible to Amplify by default, see Amplify Environment variables in the Amplify Hosting User Guide.

Source

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

The default domain for the Amplify app.

This field is required.
Source

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

The default domain for the Amplify app.

Source

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

The default domain for the Amplify app.

Source

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

Enables the auto-building of branches for the Amplify app.

This field is required.
Source

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

Enables the auto-building of branches for the Amplify app.

Source

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

Enables the auto-building of branches for the Amplify app.

Source

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

Automatically disconnect a branch in the Amplify console when you delete a branch from your Git repository.

Source

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

Automatically disconnect a branch in the Amplify console when you delete a branch from your Git repository.

Source

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

Automatically disconnect a branch in the Amplify console when you delete a branch from your Git repository.

Source

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

Enables basic authorization for the Amplify app's branches.

This field is required.
Source

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

Enables basic authorization for the Amplify app's branches.

Source

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

Enables basic authorization for the Amplify app's branches.

Source

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

The basic authorization credentials for branches for the 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 branches for the 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 branches for the Amplify app. You must base64-encode the authorization credentials and provide them in the format user:password.

Source

pub fn custom_rules(self, input: CustomRule) -> Self

Appends an item to custom_rules.

To override the contents of this collection use set_custom_rules.

Describes the custom redirect and rewrite rules for the Amplify app.

Source

pub fn set_custom_rules(self, input: Option<Vec<CustomRule>>) -> Self

Describes the custom redirect and rewrite rules for the Amplify app.

Source

pub fn get_custom_rules(&self) -> &Option<Vec<CustomRule>>

Describes the custom redirect and rewrite rules for the Amplify app.

Source

pub fn production_branch(self, input: ProductionBranch) -> Self

Describes the information about a production branch of the Amplify app.

Source

pub fn set_production_branch(self, input: Option<ProductionBranch>) -> Self

Describes the information about a production branch of the Amplify app.

Source

pub fn get_production_branch(&self) -> &Option<ProductionBranch>

Describes the information about a production branch of the Amplify app.

Source

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

Describes the content of the build specification (build spec) for the Amplify app.

Source

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

Describes the content of the build specification (build spec) for the Amplify app.

Source

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

Describes the content of the build specification (build spec) for the Amplify app.

Source

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

Describes the custom HTTP headers for the Amplify app.

Source

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

Describes the custom HTTP headers for the Amplify app.

Source

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

Describes the custom HTTP headers for the Amplify app.

Source

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

Enables automated branch creation for the Amplify app.

Source

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

Enables automated branch creation for the Amplify app.

Source

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

Enables automated branch creation for the Amplify app.

Source

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

Appends an item to auto_branch_creation_patterns.

To override the contents of this collection use set_auto_branch_creation_patterns.

Describes the automated branch creation glob patterns for the Amplify app.

Source

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

Describes the automated branch creation glob patterns for the Amplify app.

Source

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

Describes the automated branch creation glob patterns for the Amplify app.

Source

pub fn auto_branch_creation_config( self, input: AutoBranchCreationConfig, ) -> Self

Describes the automated branch creation configuration for the Amplify app.

Source

pub fn set_auto_branch_creation_config( self, input: Option<AutoBranchCreationConfig>, ) -> Self

Describes the automated branch creation configuration for the Amplify app.

Source

pub fn get_auto_branch_creation_config( &self, ) -> &Option<AutoBranchCreationConfig>

Describes the automated branch creation configuration for the Amplify app.

Source

pub fn repository_clone_method(self, input: RepositoryCloneMethod) -> Self

This is for internal use.

The Amplify service uses this parameter to specify the authentication protocol to use to access the Git repository for an Amplify app. Amplify specifies TOKEN for a GitHub repository, SIGV4 for an Amazon Web Services CodeCommit repository, and SSH for GitLab and Bitbucket repositories.

Source

pub fn set_repository_clone_method( self, input: Option<RepositoryCloneMethod>, ) -> Self

This is for internal use.

The Amplify service uses this parameter to specify the authentication protocol to use to access the Git repository for an Amplify app. Amplify specifies TOKEN for a GitHub repository, SIGV4 for an Amazon Web Services CodeCommit repository, and SSH for GitLab and Bitbucket repositories.

Source

pub fn get_repository_clone_method(&self) -> &Option<RepositoryCloneMethod>

This is for internal use.

The Amplify service uses this parameter to specify the authentication protocol to use to access the Git repository for an Amplify app. Amplify specifies TOKEN for a GitHub repository, SIGV4 for an Amazon Web Services CodeCommit repository, and SSH for GitLab and Bitbucket repositories.

Source

pub fn cache_config(self, input: CacheConfig) -> Self

The cache configuration for the Amplify app. If you don't specify the cache configuration type, Amplify uses the default AMPLIFY_MANAGED setting.

Source

pub fn set_cache_config(self, input: Option<CacheConfig>) -> Self

The cache configuration for the Amplify app. If you don't specify the cache configuration type, Amplify uses the default AMPLIFY_MANAGED setting.

Source

pub fn get_cache_config(&self) -> &Option<CacheConfig>

The cache configuration for the Amplify app. If you don't specify the cache configuration type, Amplify uses the default AMPLIFY_MANAGED setting.

Source

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

A timestamp of when Amplify created the webhook in your Git repository.

Source

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

A timestamp of when Amplify created the webhook in your Git repository.

Source

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

A timestamp of when Amplify created the webhook in your Git repository.

Source

pub fn waf_configuration(self, input: WafConfiguration) -> Self

Describes the Firewall configuration for the Amplify app. Firewall support enables you to protect your hosted applications with a direct integration with WAF.

Source

pub fn set_waf_configuration(self, input: Option<WafConfiguration>) -> Self

Describes the Firewall configuration for the Amplify app. Firewall support enables you to protect your hosted applications with a direct integration with WAF.

Source

pub fn get_waf_configuration(&self) -> &Option<WafConfiguration>

Describes the Firewall configuration for the Amplify app. Firewall support enables you to protect your hosted applications with a direct integration with WAF.

Source

pub fn job_config(self, input: JobConfig) -> Self

The configuration details that apply to the jobs for an Amplify app.

Source

pub fn set_job_config(self, input: Option<JobConfig>) -> Self

The configuration details that apply to the jobs for an Amplify app.

Source

pub fn get_job_config(&self) -> &Option<JobConfig>

The configuration details that apply to the jobs for an Amplify app.

Source

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

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

Trait Implementations§

Source§

impl Clone for AppBuilder

Source§

fn clone(&self) -> AppBuilder

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 AppBuilder

Source§

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

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

impl Default for AppBuilder

Source§

fn default() -> AppBuilder

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

impl PartialEq for AppBuilder

Source§

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

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,