aws_sdk_lambda::types::builders

Struct FunctionConfigurationBuilder

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

A builder for FunctionConfiguration.

Implementations§

Source§

impl FunctionConfigurationBuilder

Source

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

The name of the function.

Source

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

The name of the function.

Source

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

The name of the function.

Source

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

The function's Amazon Resource Name (ARN).

Source

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

The function's Amazon Resource Name (ARN).

Source

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

The function's Amazon Resource Name (ARN).

Source

pub fn runtime(self, input: Runtime) -> Self

The identifier of the function's runtime. Runtime is required if the deployment package is a .zip file archive. Specifying a runtime results in an error if you're deploying a function using a container image.

The following list includes deprecated runtimes. Lambda blocks creating new functions and updating existing functions shortly after each runtime is deprecated. For more information, see Runtime use after deprecation.

For a list of all currently supported runtimes, see Supported runtimes.

Source

pub fn set_runtime(self, input: Option<Runtime>) -> Self

The identifier of the function's runtime. Runtime is required if the deployment package is a .zip file archive. Specifying a runtime results in an error if you're deploying a function using a container image.

The following list includes deprecated runtimes. Lambda blocks creating new functions and updating existing functions shortly after each runtime is deprecated. For more information, see Runtime use after deprecation.

For a list of all currently supported runtimes, see Supported runtimes.

Source

pub fn get_runtime(&self) -> &Option<Runtime>

The identifier of the function's runtime. Runtime is required if the deployment package is a .zip file archive. Specifying a runtime results in an error if you're deploying a function using a container image.

The following list includes deprecated runtimes. Lambda blocks creating new functions and updating existing functions shortly after each runtime is deprecated. For more information, see Runtime use after deprecation.

For a list of all currently supported runtimes, see Supported runtimes.

Source

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

The function's execution role.

Source

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

The function's execution role.

Source

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

The function's execution role.

Source

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

The function that Lambda calls to begin running your function.

Source

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

The function that Lambda calls to begin running your function.

Source

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

The function that Lambda calls to begin running your function.

Source

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

The size of the function's deployment package, in bytes.

Source

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

The size of the function's deployment package, in bytes.

Source

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

The size of the function's deployment package, in bytes.

Source

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

The function's description.

Source

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

The function's description.

Source

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

The function's description.

Source

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

The amount of time in seconds that Lambda allows a function to run before stopping it.

Source

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

The amount of time in seconds that Lambda allows a function to run before stopping it.

Source

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

The amount of time in seconds that Lambda allows a function to run before stopping it.

Source

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

The amount of memory available to the function at runtime.

Source

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

The amount of memory available to the function at runtime.

Source

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

The amount of memory available to the function at runtime.

Source

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

The date and time that the function was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

Source

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

The date and time that the function was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

Source

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

The date and time that the function was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

Source

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

The SHA256 hash of the function's deployment package.

Source

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

The SHA256 hash of the function's deployment package.

Source

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

The SHA256 hash of the function's deployment package.

Source

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

The version of the Lambda function.

Source

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

The version of the Lambda function.

Source

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

The version of the Lambda function.

Source

pub fn vpc_config(self, input: VpcConfigResponse) -> Self

The function's networking configuration.

Source

pub fn set_vpc_config(self, input: Option<VpcConfigResponse>) -> Self

The function's networking configuration.

Source

pub fn get_vpc_config(&self) -> &Option<VpcConfigResponse>

The function's networking configuration.

Source

pub fn dead_letter_config(self, input: DeadLetterConfig) -> Self

The function's dead letter queue.

Source

pub fn set_dead_letter_config(self, input: Option<DeadLetterConfig>) -> Self

The function's dead letter queue.

Source

pub fn get_dead_letter_config(&self) -> &Option<DeadLetterConfig>

The function's dead letter queue.

Source

pub fn environment(self, input: EnvironmentResponse) -> Self

The function's environment variables. Omitted from CloudTrail logs.

Source

pub fn set_environment(self, input: Option<EnvironmentResponse>) -> Self

The function's environment variables. Omitted from CloudTrail logs.

Source

pub fn get_environment(&self) -> &Option<EnvironmentResponse>

The function's environment variables. Omitted from CloudTrail logs.

Source

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

The ARN of the Key Management Service (KMS) customer managed key that's used to encrypt the following resources:

  • The function's environment variables.

  • The function's Lambda SnapStart snapshots.

  • When used with SourceKMSKeyArn, the unzipped version of the .zip deployment package that's used for function invocations. For more information, see Specifying a customer managed key for Lambda.

  • The optimized version of the container image that's used for function invocations. Note that this is not the same key that's used to protect your container image in the Amazon Elastic Container Registry (Amazon ECR). For more information, see Function lifecycle.

If you don't provide a customer managed key, Lambda uses an Amazon Web Services owned key or an Amazon Web Services managed key.

Source

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

The ARN of the Key Management Service (KMS) customer managed key that's used to encrypt the following resources:

  • The function's environment variables.

  • The function's Lambda SnapStart snapshots.

  • When used with SourceKMSKeyArn, the unzipped version of the .zip deployment package that's used for function invocations. For more information, see Specifying a customer managed key for Lambda.

  • The optimized version of the container image that's used for function invocations. Note that this is not the same key that's used to protect your container image in the Amazon Elastic Container Registry (Amazon ECR). For more information, see Function lifecycle.

If you don't provide a customer managed key, Lambda uses an Amazon Web Services owned key or an Amazon Web Services managed key.

Source

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

The ARN of the Key Management Service (KMS) customer managed key that's used to encrypt the following resources:

  • The function's environment variables.

  • The function's Lambda SnapStart snapshots.

  • When used with SourceKMSKeyArn, the unzipped version of the .zip deployment package that's used for function invocations. For more information, see Specifying a customer managed key for Lambda.

  • The optimized version of the container image that's used for function invocations. Note that this is not the same key that's used to protect your container image in the Amazon Elastic Container Registry (Amazon ECR). For more information, see Function lifecycle.

If you don't provide a customer managed key, Lambda uses an Amazon Web Services owned key or an Amazon Web Services managed key.

Source

pub fn tracing_config(self, input: TracingConfigResponse) -> Self

The function's X-Ray tracing configuration.

Source

pub fn set_tracing_config(self, input: Option<TracingConfigResponse>) -> Self

The function's X-Ray tracing configuration.

Source

pub fn get_tracing_config(&self) -> &Option<TracingConfigResponse>

The function's X-Ray tracing configuration.

Source

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

For Lambda@Edge functions, the ARN of the main function.

Source

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

For Lambda@Edge functions, the ARN of the main function.

Source

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

For Lambda@Edge functions, the ARN of the main function.

Source

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

The latest updated revision of the function or alias.

Source

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

The latest updated revision of the function or alias.

Source

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

The latest updated revision of the function or alias.

Source

pub fn layers(self, input: Layer) -> Self

Appends an item to layers.

To override the contents of this collection use set_layers.

The function's layers.

Source

pub fn set_layers(self, input: Option<Vec<Layer>>) -> Self

The function's layers.

Source

pub fn get_layers(&self) -> &Option<Vec<Layer>>

The function's layers.

Source

pub fn state(self, input: State) -> Self

The current state of the function. When the state is Inactive, you can reactivate the function by invoking it.

Source

pub fn set_state(self, input: Option<State>) -> Self

The current state of the function. When the state is Inactive, you can reactivate the function by invoking it.

Source

pub fn get_state(&self) -> &Option<State>

The current state of the function. When the state is Inactive, you can reactivate the function by invoking it.

Source

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

The reason for the function's current state.

Source

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

The reason for the function's current state.

Source

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

The reason for the function's current state.

Source

pub fn state_reason_code(self, input: StateReasonCode) -> Self

The reason code for the function's current state. When the code is Creating, you can't invoke or modify the function.

Source

pub fn set_state_reason_code(self, input: Option<StateReasonCode>) -> Self

The reason code for the function's current state. When the code is Creating, you can't invoke or modify the function.

Source

pub fn get_state_reason_code(&self) -> &Option<StateReasonCode>

The reason code for the function's current state. When the code is Creating, you can't invoke or modify the function.

Source

pub fn last_update_status(self, input: LastUpdateStatus) -> Self

The status of the last update that was performed on the function. This is first set to Successful after function creation completes.

Source

pub fn set_last_update_status(self, input: Option<LastUpdateStatus>) -> Self

The status of the last update that was performed on the function. This is first set to Successful after function creation completes.

Source

pub fn get_last_update_status(&self) -> &Option<LastUpdateStatus>

The status of the last update that was performed on the function. This is first set to Successful after function creation completes.

Source

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

The reason for the last update that was performed on the function.

Source

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

The reason for the last update that was performed on the function.

Source

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

The reason for the last update that was performed on the function.

Source

pub fn last_update_status_reason_code( self, input: LastUpdateStatusReasonCode, ) -> Self

The reason code for the last update that was performed on the function.

Source

pub fn set_last_update_status_reason_code( self, input: Option<LastUpdateStatusReasonCode>, ) -> Self

The reason code for the last update that was performed on the function.

Source

pub fn get_last_update_status_reason_code( &self, ) -> &Option<LastUpdateStatusReasonCode>

The reason code for the last update that was performed on the function.

Source

pub fn file_system_configs(self, input: FileSystemConfig) -> Self

Appends an item to file_system_configs.

To override the contents of this collection use set_file_system_configs.

Connection settings for an Amazon EFS file system.

Source

pub fn set_file_system_configs( self, input: Option<Vec<FileSystemConfig>>, ) -> Self

Connection settings for an Amazon EFS file system.

Source

pub fn get_file_system_configs(&self) -> &Option<Vec<FileSystemConfig>>

Connection settings for an Amazon EFS file system.

Source

pub fn package_type(self, input: PackageType) -> Self

The type of deployment package. Set to Image for container image and set Zip for .zip file archive.

Source

pub fn set_package_type(self, input: Option<PackageType>) -> Self

The type of deployment package. Set to Image for container image and set Zip for .zip file archive.

Source

pub fn get_package_type(&self) -> &Option<PackageType>

The type of deployment package. Set to Image for container image and set Zip for .zip file archive.

Source

pub fn image_config_response(self, input: ImageConfigResponse) -> Self

The function's image configuration values.

Source

pub fn set_image_config_response( self, input: Option<ImageConfigResponse>, ) -> Self

The function's image configuration values.

Source

pub fn get_image_config_response(&self) -> &Option<ImageConfigResponse>

The function's image configuration values.

Source

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

The ARN of the signing profile version.

Source

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

The ARN of the signing profile version.

Source

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

The ARN of the signing profile version.

Source

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

The ARN of the signing job.

Source

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

The ARN of the signing job.

Source

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

The ARN of the signing job.

Source

pub fn architectures(self, input: Architecture) -> Self

Appends an item to architectures.

To override the contents of this collection use set_architectures.

The instruction set architecture that the function supports. Architecture is a string array with one of the valid values. The default architecture value is x86_64.

Source

pub fn set_architectures(self, input: Option<Vec<Architecture>>) -> Self

The instruction set architecture that the function supports. Architecture is a string array with one of the valid values. The default architecture value is x86_64.

Source

pub fn get_architectures(&self) -> &Option<Vec<Architecture>>

The instruction set architecture that the function supports. Architecture is a string array with one of the valid values. The default architecture value is x86_64.

Source

pub fn ephemeral_storage(self, input: EphemeralStorage) -> Self

The size of the function's /tmp directory in MB. The default value is 512, but can be any whole number between 512 and 10,240 MB. For more information, see Configuring ephemeral storage (console).

Source

pub fn set_ephemeral_storage(self, input: Option<EphemeralStorage>) -> Self

The size of the function's /tmp directory in MB. The default value is 512, but can be any whole number between 512 and 10,240 MB. For more information, see Configuring ephemeral storage (console).

Source

pub fn get_ephemeral_storage(&self) -> &Option<EphemeralStorage>

The size of the function's /tmp directory in MB. The default value is 512, but can be any whole number between 512 and 10,240 MB. For more information, see Configuring ephemeral storage (console).

Source

pub fn snap_start(self, input: SnapStartResponse) -> Self

Set ApplyOn to PublishedVersions to create a snapshot of the initialized execution environment when you publish a function version. For more information, see Improving startup performance with Lambda SnapStart.

Source

pub fn set_snap_start(self, input: Option<SnapStartResponse>) -> Self

Set ApplyOn to PublishedVersions to create a snapshot of the initialized execution environment when you publish a function version. For more information, see Improving startup performance with Lambda SnapStart.

Source

pub fn get_snap_start(&self) -> &Option<SnapStartResponse>

Set ApplyOn to PublishedVersions to create a snapshot of the initialized execution environment when you publish a function version. For more information, see Improving startup performance with Lambda SnapStart.

Source

pub fn runtime_version_config(self, input: RuntimeVersionConfig) -> Self

The ARN of the runtime and any errors that occured.

Source

pub fn set_runtime_version_config( self, input: Option<RuntimeVersionConfig>, ) -> Self

The ARN of the runtime and any errors that occured.

Source

pub fn get_runtime_version_config(&self) -> &Option<RuntimeVersionConfig>

The ARN of the runtime and any errors that occured.

Source

pub fn logging_config(self, input: LoggingConfig) -> Self

The function's Amazon CloudWatch Logs configuration settings.

Source

pub fn set_logging_config(self, input: Option<LoggingConfig>) -> Self

The function's Amazon CloudWatch Logs configuration settings.

Source

pub fn get_logging_config(&self) -> &Option<LoggingConfig>

The function's Amazon CloudWatch Logs configuration settings.

Source

pub fn build(self) -> FunctionConfiguration

Consumes the builder and constructs a FunctionConfiguration.

Trait Implementations§

Source§

impl Clone for FunctionConfigurationBuilder

Source§

fn clone(&self) -> FunctionConfigurationBuilder

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 FunctionConfigurationBuilder

Source§

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

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

impl Default for FunctionConfigurationBuilder

Source§

fn default() -> FunctionConfigurationBuilder

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

impl PartialEq for FunctionConfigurationBuilder

Source§

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

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,