Struct ImageBuilder

Source

#[non_exhaustive]
pub struct ImageBuilder { /* private fields */ }

Expand description

A builder for Image.

Implementations§

Source §

impl ImageBuilder

Source

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

The Amazon Resource Name (ARN) of the image.

Semantic versioning is included in each object's Amazon Resource Name (ARN), at the level that applies to that object as follows:

Versionless ARNs and Name ARNs do not include specific values in any of the nodes. The nodes are either left off entirely, or they are specified as wildcards, for example: x.x.x.
Version ARNs have only the first three nodes: . .
Build version ARNs have all four nodes, and point to a specific build for a specific version of an object.

Source

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

The Amazon Resource Name (ARN) of the image.

Semantic versioning is included in each object's Amazon Resource Name (ARN), at the level that applies to that object as follows:

Versionless ARNs and Name ARNs do not include specific values in any of the nodes. The nodes are either left off entirely, or they are specified as wildcards, for example: x.x.x.
Version ARNs have only the first three nodes: . .
Build version ARNs have all four nodes, and point to a specific build for a specific version of an object.

Source

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

The Amazon Resource Name (ARN) of the image.

Semantic versioning is included in each object's Amazon Resource Name (ARN), at the level that applies to that object as follows:

Versionless ARNs and Name ARNs do not include specific values in any of the nodes. The nodes are either left off entirely, or they are specified as wildcards, for example: x.x.x.
Version ARNs have only the first three nodes: . .
Build version ARNs have all four nodes, and point to a specific build for a specific version of an object.

Source

pub fn type(self, input: ImageType) -> Self

Specifies whether this image produces an AMI or a container image.

Source

pub fn set_type(self, input: Option<ImageType>) -> Self

Specifies whether this image produces an AMI or a container image.

Source

pub fn get_type(&self) -> &Option<ImageType>

Specifies whether this image produces an AMI or a container image.

Source

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

The name of the image.

Source

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

The name of the image.

Source

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

The name of the image.

Source

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

The semantic version of the image.

The semantic version has four nodes: . . / . You can assign values for the first three, and can filter on all of them.

Assignment: For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node.

Patterns: You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.

Filtering: With semantic versioning, you have the flexibility to use wildcards (x) to specify the most recent versions or nodes when selecting the base image or components for your recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards.

Source

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

The semantic version of the image.

The semantic version has four nodes: . . / . You can assign values for the first three, and can filter on all of them.

Assignment: For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node.

Patterns: You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.

Filtering: With semantic versioning, you have the flexibility to use wildcards (x) to specify the most recent versions or nodes when selecting the base image or components for your recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards.

Source

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

The semantic version of the image.

The semantic version has four nodes: . . / . You can assign values for the first three, and can filter on all of them.

Assignment: For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node.

Patterns: You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.

Filtering: With semantic versioning, you have the flexibility to use wildcards (x) to specify the most recent versions or nodes when selecting the base image or components for your recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards.

Source

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

The image operating system platform, such as Linux or Windows.

Source

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

The image operating system platform, such as Linux or Windows.

Source

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

The image operating system platform, such as Linux or Windows.

Source

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

Indicates whether Image Builder collects additional information about the image, such as the operating system (OS) version and package list.

Source

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

Indicates whether Image Builder collects additional information about the image, such as the operating system (OS) version and package list.

Source

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

Indicates whether Image Builder collects additional information about the image, such as the operating system (OS) version and package list.

Source

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

The operating system version for instances that launch from this image. For example, Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019.

Source

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

The operating system version for instances that launch from this image. For example, Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019.

Source

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

The operating system version for instances that launch from this image. For example, Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019.

Source

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

The state of the image.

Source

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

The state of the image.

Source

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

The state of the image.

Source

pub fn image_recipe(self, input: ImageRecipe) -> Self

For images that distribute an AMI, this is the image recipe that Image Builder used to create the image. For container images, this is empty.

Source

pub fn set_image_recipe(self, input: Option<ImageRecipe>) -> Self

For images that distribute an AMI, this is the image recipe that Image Builder used to create the image. For container images, this is empty.

Source

pub fn get_image_recipe(&self) -> &Option<ImageRecipe>

For images that distribute an AMI, this is the image recipe that Image Builder used to create the image. For container images, this is empty.

Source

pub fn container_recipe(self, input: ContainerRecipe) -> Self

For container images, this is the container recipe that Image Builder used to create the image. For images that distribute an AMI, this is empty.

Source

pub fn set_container_recipe(self, input: Option<ContainerRecipe>) -> Self

For container images, this is the container recipe that Image Builder used to create the image. For images that distribute an AMI, this is empty.

Source

pub fn get_container_recipe(&self) -> &Option<ContainerRecipe>

For container images, this is the container recipe that Image Builder used to create the image. For images that distribute an AMI, this is empty.

Source

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

The name of the image pipeline that created this image.

Source

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

The name of the image pipeline that created this image.

Source

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

The name of the image pipeline that created this image.

Source

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

The Amazon Resource Name (ARN) of the image pipeline that created this image.

Source

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

The Amazon Resource Name (ARN) of the image pipeline that created this image.

Source

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

The Amazon Resource Name (ARN) of the image pipeline that created this image.

Source

pub fn infrastructure_configuration( self, input: InfrastructureConfiguration, ) -> Self

The infrastructure that Image Builder used to create this image.

Source

pub fn set_infrastructure_configuration( self, input: Option<InfrastructureConfiguration>, ) -> Self

The infrastructure that Image Builder used to create this image.

Source

pub fn get_infrastructure_configuration( &self, ) -> &Option<InfrastructureConfiguration>

The infrastructure that Image Builder used to create this image.

Source

pub fn distribution_configuration( self, input: DistributionConfiguration, ) -> Self

The distribution configuration that Image Builder used to create this image.

Source

pub fn set_distribution_configuration( self, input: Option<DistributionConfiguration>, ) -> Self

The distribution configuration that Image Builder used to create this image.

Source

pub fn get_distribution_configuration( &self, ) -> &Option<DistributionConfiguration>

The distribution configuration that Image Builder used to create this image.

Source

pub fn image_tests_configuration(self, input: ImageTestsConfiguration) -> Self

The image tests that ran when that Image Builder created this image.

Source

pub fn set_image_tests_configuration( self, input: Option<ImageTestsConfiguration>, ) -> Self

The image tests that ran when that Image Builder created this image.

Source

pub fn get_image_tests_configuration(&self) -> &Option<ImageTestsConfiguration>

The image tests that ran when that Image Builder created this image.

Source

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

The date on which Image Builder created this image.

Source

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

The date on which Image Builder created this image.

Source

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

The date on which Image Builder created this image.

Source

pub fn output_resources(self, input: OutputResources) -> Self

The output resources that Image Builder produces for this image.

Source

pub fn set_output_resources(self, input: Option<OutputResources>) -> Self

The output resources that Image Builder produces for this image.

Source

pub fn get_output_resources(&self) -> &Option<OutputResources>

The output resources that Image Builder produces for this image.

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 tags that apply to this image.

Source

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

The tags that apply to this image.

Source

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

The tags that apply to this image.

Source

pub fn build_type(self, input: BuildType) -> Self

Indicates the type of build that created this image. The build can be initiated in the following ways:

USER_INITIATED – A manual pipeline build request.
SCHEDULED – A pipeline build initiated by a cron expression in the Image Builder pipeline, or from EventBridge.
IMPORT – A VM import created the image to use as the base image for the recipe.
IMPORT_ISO – An ISO disk import created the image.

Source

pub fn set_build_type(self, input: Option<BuildType>) -> Self

Indicates the type of build that created this image. The build can be initiated in the following ways:

USER_INITIATED – A manual pipeline build request.
SCHEDULED – A pipeline build initiated by a cron expression in the Image Builder pipeline, or from EventBridge.
IMPORT – A VM import created the image to use as the base image for the recipe.
IMPORT_ISO – An ISO disk import created the image.

Source

pub fn get_build_type(&self) -> &Option<BuildType>

Indicates the type of build that created this image. The build can be initiated in the following ways:

USER_INITIATED – A manual pipeline build request.
SCHEDULED – A pipeline build initiated by a cron expression in the Image Builder pipeline, or from EventBridge.
IMPORT – A VM import created the image to use as the base image for the recipe.
IMPORT_ISO – An ISO disk import created the image.

Source

pub fn image_source(self, input: ImageSource) -> Self

The origin of the base image that Image Builder used to build this image.

Source

pub fn set_image_source(self, input: Option<ImageSource>) -> Self

The origin of the base image that Image Builder used to build this image.

Source

pub fn get_image_source(&self) -> &Option<ImageSource>

The origin of the base image that Image Builder used to build this image.

Source

pub fn scan_state(self, input: ImageScanState) -> Self

Contains information about the current state of scans for this image.

Source

pub fn set_scan_state(self, input: Option<ImageScanState>) -> Self

Contains information about the current state of scans for this image.

Source

pub fn get_scan_state(&self) -> &Option<ImageScanState>

Contains information about the current state of scans for this image.

Source

pub fn image_scanning_configuration( self, input: ImageScanningConfiguration, ) -> Self

Contains settings for vulnerability scans.

Source

pub fn set_image_scanning_configuration( self, input: Option<ImageScanningConfiguration>, ) -> Self

Contains settings for vulnerability scans.

Source

pub fn get_image_scanning_configuration( &self, ) -> &Option<ImageScanningConfiguration>

Contains settings for vulnerability scans.

Source

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

The time when deprecation occurs for an image resource. This can be a past or future date.

Source

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

The time when deprecation occurs for an image resource. This can be a past or future date.

Source

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

The time when deprecation occurs for an image resource. This can be a past or future date.

Source

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

Identifies the last runtime instance of the lifecycle policy to take action on the image.

Source

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

Identifies the last runtime instance of the lifecycle policy to take action on the image.

Source

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

Identifies the last runtime instance of the lifecycle policy to take action on the image.

Source

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

The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions.

Source

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

The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions.

Source

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

The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions.

Source

pub fn workflows(self, input: WorkflowConfiguration) -> Self

Appends an item to workflows.

To override the contents of this collection use set_workflows.

Contains the build and test workflows that are associated with the image.

Source

pub fn set_workflows(self, input: Option<Vec<WorkflowConfiguration>>) -> Self

Contains the build and test workflows that are associated with the image.

Source

pub fn get_workflows(&self) -> &Option<Vec<WorkflowConfiguration>>

Contains the build and test workflows that are associated with the image.

Source

pub fn build(self) -> Image

Consumes the builder and constructs a Image.

Trait Implementations§

Source §

impl Clone for ImageBuilder

Source §

fn clone(&self) -> ImageBuilder

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 ImageBuilder

Source §

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

Formats the value using the given formatter. Read more

Source §

impl Default for ImageBuilder

Source §

fn default() -> ImageBuilder

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

Source §

impl PartialEq for ImageBuilder

Source §

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

Auto Trait Implementations§

§

impl UnwindSafe for ImageBuilder

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 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());

Source §

fn blink(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Blink].

§Example

println!("{}", value.blink());

Source §

fn rapid_blink(&self) -> Painted<&T>

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 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>::Error>

Performs the conversion.

Source §

impl<T, U> TryInto for T
where U: TryFrom<T>,

Source §

type Error = >::Error

The type returned in the event of a conversion error.

Source §

fn try_into(self) -> Result<U, >::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 §

Struct ImageBuilderCopy item path

Implementations§

impl ImageBuilder

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

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

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

pub fn type(self, input: ImageType) -> Self

pub fn set_type(self, input: Option<ImageType>) -> Self

pub fn get_type(&self) -> &Option<ImageType>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

pub fn image_recipe(self, input: ImageRecipe) -> Self

pub fn set_image_recipe(self, input: Option<ImageRecipe>) -> Self

pub fn get_image_recipe(&self) -> &Option<ImageRecipe>

pub fn container_recipe(self, input: ContainerRecipe) -> Self

pub fn set_container_recipe(self, input: Option<ContainerRecipe>) -> Self

pub fn get_container_recipe(&self) -> &Option<ContainerRecipe>

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

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

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

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

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

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

pub fn infrastructure_configuration( self, input: InfrastructureConfiguration, ) -> Self

pub fn set_infrastructure_configuration( self, input: Option<InfrastructureConfiguration>, ) -> Self

pub fn get_infrastructure_configuration( &self, ) -> &Option<InfrastructureConfiguration>

pub fn distribution_configuration( self, input: DistributionConfiguration, ) -> Self

pub fn set_distribution_configuration( self, input: Option<DistributionConfiguration>, ) -> Self

pub fn get_distribution_configuration( &self, ) -> &Option<DistributionConfiguration>

pub fn image_tests_configuration(self, input: ImageTestsConfiguration) -> Self

pub fn set_image_tests_configuration( self, input: Option<ImageTestsConfiguration>, ) -> Self

pub fn get_image_tests_configuration(&self) -> &Option<ImageTestsConfiguration>

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

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

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

pub fn output_resources(self, input: OutputResources) -> Self

pub fn set_output_resources(self, input: Option<OutputResources>) -> Self

pub fn get_output_resources(&self) -> &Option<OutputResources>

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

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

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

pub fn build_type(self, input: BuildType) -> Self

pub fn set_build_type(self, input: Option<BuildType>) -> Self

pub fn get_build_type(&self) -> &Option<BuildType>

pub fn image_source(self, input: ImageSource) -> Self

pub fn set_image_source(self, input: Option<ImageSource>) -> Self

pub fn get_image_source(&self) -> &Option<ImageSource>

pub fn scan_state(self, input: ImageScanState) -> Self

pub fn set_scan_state(self, input: Option<ImageScanState>) -> Self

pub fn get_scan_state(&self) -> &Option<ImageScanState>

pub fn image_scanning_configuration( self, input: ImageScanningConfiguration, ) -> Self

pub fn set_image_scanning_configuration( self, input: Option<ImageScanningConfiguration>, ) -> Self

pub fn get_image_scanning_configuration( &self, ) -> &Option<ImageScanningConfiguration>

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

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

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

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

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

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

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

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

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

pub fn workflows(self, input: WorkflowConfiguration) -> Self

pub fn set_workflows(self, input: Option<Vec<WorkflowConfiguration>>) -> Self

Struct ImageBuilder

impl<T> Any for T
where T: 'static + ?Sized,

impl<T> Borrow<T> for T
where T: ?Sized,

impl<T> BorrowMut<T> for T
where T: ?Sized,

impl<T> CloneToUninit for T
where T: Clone,

impl<T, U> Into<U> for T
where U: From<T>,

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

impl<T> Paint for T
where T: ?Sized,