aws_sdk_ec2::types::builders

Struct ImageBuilder

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

A builder for Image.

Implementations§

Source§

impl ImageBuilder

Source

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

The platform details associated with the billing code of the AMI. For more information, see Understand AMI billing information in the Amazon EC2 User Guide.

Source

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

The platform details associated with the billing code of the AMI. For more information, see Understand AMI billing information in the Amazon EC2 User Guide.

Source

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

The platform details associated with the billing code of the AMI. For more information, see Understand AMI billing information in the Amazon EC2 User Guide.

Source

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

The operation of the Amazon EC2 instance and the billing code that is associated with the AMI. usageOperation corresponds to the lineitem/Operation column on your Amazon Web Services Cost and Usage Report and in the Amazon Web Services Price List API. You can view these fields on the Instances or AMIs pages in the Amazon EC2 console, or in the responses that are returned by the DescribeImages command in the Amazon EC2 API, or the describe-images command in the CLI.

Source

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

The operation of the Amazon EC2 instance and the billing code that is associated with the AMI. usageOperation corresponds to the lineitem/Operation column on your Amazon Web Services Cost and Usage Report and in the Amazon Web Services Price List API. You can view these fields on the Instances or AMIs pages in the Amazon EC2 console, or in the responses that are returned by the DescribeImages command in the Amazon EC2 API, or the describe-images command in the CLI.

Source

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

The operation of the Amazon EC2 instance and the billing code that is associated with the AMI. usageOperation corresponds to the lineitem/Operation column on your Amazon Web Services Cost and Usage Report and in the Amazon Web Services Price List API. You can view these fields on the Instances or AMIs pages in the Amazon EC2 console, or in the responses that are returned by the DescribeImages command in the Amazon EC2 API, or the describe-images command in the CLI.

Source

pub fn block_device_mappings(self, input: BlockDeviceMapping) -> Self

Appends an item to block_device_mappings.

To override the contents of this collection use set_block_device_mappings.

Any block device mapping entries.

Source

pub fn set_block_device_mappings( self, input: Option<Vec<BlockDeviceMapping>>, ) -> Self

Any block device mapping entries.

Source

pub fn get_block_device_mappings(&self) -> &Option<Vec<BlockDeviceMapping>>

Any block device mapping entries.

Source

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

The description of the AMI that was provided during image creation.

Source

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

The description of the AMI that was provided during image creation.

Source

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

The description of the AMI that was provided during image creation.

Source

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

Specifies whether enhanced networking with ENA is enabled.

Source

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

Specifies whether enhanced networking with ENA is enabled.

Source

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

Specifies whether enhanced networking with ENA is enabled.

Source

pub fn hypervisor(self, input: HypervisorType) -> Self

The hypervisor type of the image. Only xen is supported. ovm is not supported.

Source

pub fn set_hypervisor(self, input: Option<HypervisorType>) -> Self

The hypervisor type of the image. Only xen is supported. ovm is not supported.

Source

pub fn get_hypervisor(&self) -> &Option<HypervisorType>

The hypervisor type of the image. Only xen is supported. ovm is not supported.

Source

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

The owner alias (amazon | aws-backup-vault | aws-marketplace).

Source

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

The owner alias (amazon | aws-backup-vault | aws-marketplace).

Source

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

The owner alias (amazon | aws-backup-vault | aws-marketplace).

Source

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

The name of the AMI that was provided during image creation.

Source

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

The name of the AMI that was provided during image creation.

Source

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

The name of the AMI that was provided during image creation.

Source

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

The device name of the root device volume (for example, /dev/sda1).

Source

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

The device name of the root device volume (for example, /dev/sda1).

Source

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

The device name of the root device volume (for example, /dev/sda1).

Source

pub fn root_device_type(self, input: DeviceType) -> Self

The type of root device used by the AMI. The AMI can use an Amazon EBS volume or an instance store volume.

Source

pub fn set_root_device_type(self, input: Option<DeviceType>) -> Self

The type of root device used by the AMI. The AMI can use an Amazon EBS volume or an instance store volume.

Source

pub fn get_root_device_type(&self) -> &Option<DeviceType>

The type of root device used by the AMI. The AMI can use an Amazon EBS volume or an instance store volume.

Source

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

Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.

Source

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

Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.

Source

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

Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.

Source

pub fn state_reason(self, input: StateReason) -> Self

The reason for the state change.

Source

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

The reason for the state change.

Source

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

The reason for the state change.

Source

pub fn tags(self, input: Tag) -> Self

Appends an item to tags.

To override the contents of this collection use set_tags.

Any tags assigned to the image.

Source

pub fn set_tags(self, input: Option<Vec<Tag>>) -> Self

Any tags assigned to the image.

Source

pub fn get_tags(&self) -> &Option<Vec<Tag>>

Any tags assigned to the image.

Source

pub fn virtualization_type(self, input: VirtualizationType) -> Self

The type of virtualization of the AMI.

Source

pub fn set_virtualization_type(self, input: Option<VirtualizationType>) -> Self

The type of virtualization of the AMI.

Source

pub fn get_virtualization_type(&self) -> &Option<VirtualizationType>

The type of virtualization of the AMI.

Source

pub fn boot_mode(self, input: BootModeValues) -> Self

The boot mode of the image. For more information, see Instance launch behavior with Amazon EC2 boot modes in the Amazon EC2 User Guide.

Source

pub fn set_boot_mode(self, input: Option<BootModeValues>) -> Self

The boot mode of the image. For more information, see Instance launch behavior with Amazon EC2 boot modes in the Amazon EC2 User Guide.

Source

pub fn get_boot_mode(&self) -> &Option<BootModeValues>

The boot mode of the image. For more information, see Instance launch behavior with Amazon EC2 boot modes in the Amazon EC2 User Guide.

Source

pub fn tpm_support(self, input: TpmSupportValues) -> Self

If the image is configured for NitroTPM support, the value is v2.0. For more information, see NitroTPM in the Amazon EC2 User Guide.

Source

pub fn set_tpm_support(self, input: Option<TpmSupportValues>) -> Self

If the image is configured for NitroTPM support, the value is v2.0. For more information, see NitroTPM in the Amazon EC2 User Guide.

Source

pub fn get_tpm_support(&self) -> &Option<TpmSupportValues>

If the image is configured for NitroTPM support, the value is v2.0. For more information, see NitroTPM in the Amazon EC2 User Guide.

Source

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

The date and time to deprecate the AMI, in UTC, in the following format: YYYY-MM-DDTHH:MM:SSZ. If you specified a value for seconds, Amazon EC2 rounds the seconds to the nearest minute.

Source

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

The date and time to deprecate the AMI, in UTC, in the following format: YYYY-MM-DDTHH:MM:SSZ. If you specified a value for seconds, Amazon EC2 rounds the seconds to the nearest minute.

Source

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

The date and time to deprecate the AMI, in UTC, in the following format: YYYY-MM-DDTHH:MM:SSZ. If you specified a value for seconds, Amazon EC2 rounds the seconds to the nearest minute.

Source

pub fn imds_support(self, input: ImdsSupportValues) -> Self

If v2.0, it indicates that IMDSv2 is specified in the AMI. Instances launched from this AMI will have HttpTokens automatically set to required so that, by default, the instance requires that IMDSv2 is used when requesting instance metadata. In addition, HttpPutResponseHopLimit is set to 2. For more information, see Configure the AMI in the Amazon EC2 User Guide.

Source

pub fn set_imds_support(self, input: Option<ImdsSupportValues>) -> Self

If v2.0, it indicates that IMDSv2 is specified in the AMI. Instances launched from this AMI will have HttpTokens automatically set to required so that, by default, the instance requires that IMDSv2 is used when requesting instance metadata. In addition, HttpPutResponseHopLimit is set to 2. For more information, see Configure the AMI in the Amazon EC2 User Guide.

Source

pub fn get_imds_support(&self) -> &Option<ImdsSupportValues>

If v2.0, it indicates that IMDSv2 is specified in the AMI. Instances launched from this AMI will have HttpTokens automatically set to required so that, by default, the instance requires that IMDSv2 is used when requesting instance metadata. In addition, HttpPutResponseHopLimit is set to 2. For more information, see Configure the AMI in the Amazon EC2 User Guide.

Source

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

The ID of the instance that the AMI was created from if the AMI was created using CreateImage. This field only appears if the AMI was created using CreateImage.

Source

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

The ID of the instance that the AMI was created from if the AMI was created using CreateImage. This field only appears if the AMI was created using CreateImage.

Source

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

The ID of the instance that the AMI was created from if the AMI was created using CreateImage. This field only appears if the AMI was created using CreateImage.

Source

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

Indicates whether deregistration protection is enabled for the AMI.

Source

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

Indicates whether deregistration protection is enabled for the AMI.

Source

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

Indicates whether deregistration protection is enabled for the AMI.

Source

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

The date and time, in ISO 8601 date-time format, when the AMI was last used to launch an EC2 instance. When the AMI is used to launch an instance, there is a 24-hour delay before that usage is reported.

lastLaunchedTime data is available starting April 2017.

Source

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

The date and time, in ISO 8601 date-time format, when the AMI was last used to launch an EC2 instance. When the AMI is used to launch an instance, there is a 24-hour delay before that usage is reported.

lastLaunchedTime data is available starting April 2017.

Source

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

The date and time, in ISO 8601 date-time format, when the AMI was last used to launch an EC2 instance. When the AMI is used to launch an instance, there is a 24-hour delay before that usage is reported.

lastLaunchedTime data is available starting April 2017.

Source

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

If true, the AMI satisfies the criteria for Allowed AMIs and can be discovered and used in the account. If false and Allowed AMIs is set to enabled, the AMI can't be discovered or used in the account. If false and Allowed AMIs is set to audit-mode, the AMI can be discovered and used in the account.

For more information, see Control the discovery and use of AMIs in Amazon EC2 with Allowed AMIs in Amazon EC2 User Guide.

Source

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

If true, the AMI satisfies the criteria for Allowed AMIs and can be discovered and used in the account. If false and Allowed AMIs is set to enabled, the AMI can't be discovered or used in the account. If false and Allowed AMIs is set to audit-mode, the AMI can be discovered and used in the account.

For more information, see Control the discovery and use of AMIs in Amazon EC2 with Allowed AMIs in Amazon EC2 User Guide.

Source

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

If true, the AMI satisfies the criteria for Allowed AMIs and can be discovered and used in the account. If false and Allowed AMIs is set to enabled, the AMI can't be discovered or used in the account. If false and Allowed AMIs is set to audit-mode, the AMI can be discovered and used in the account.

For more information, see Control the discovery and use of AMIs in Amazon EC2 with Allowed AMIs in Amazon EC2 User Guide.

Source

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

The ID of the source AMI from which the AMI was created.

The ID only appears if the AMI was created using CreateImage, CopyImage, or CreateRestoreImageTask. The ID does not appear if the AMI was created using any other API. For some older AMIs, the ID might not be available. For more information, see Identify the source AMI used to create a new Amazon EC2 AMI in the Amazon EC2 User Guide.

Source

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

The ID of the source AMI from which the AMI was created.

The ID only appears if the AMI was created using CreateImage, CopyImage, or CreateRestoreImageTask. The ID does not appear if the AMI was created using any other API. For some older AMIs, the ID might not be available. For more information, see Identify the source AMI used to create a new Amazon EC2 AMI in the Amazon EC2 User Guide.

Source

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

The ID of the source AMI from which the AMI was created.

The ID only appears if the AMI was created using CreateImage, CopyImage, or CreateRestoreImageTask. The ID does not appear if the AMI was created using any other API. For some older AMIs, the ID might not be available. For more information, see Identify the source AMI used to create a new Amazon EC2 AMI in the Amazon EC2 User Guide.

Source

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

The Region of the source AMI.

The Region only appears if the AMI was created using CreateImage, CopyImage, or CreateRestoreImageTask. The Region does not appear if the AMI was created using any other API. For some older AMIs, the Region might not be available. For more information, see Identify the source AMI used to create a new Amazon EC2 AMI in the Amazon EC2 User Guide.

Source

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

The Region of the source AMI.

The Region only appears if the AMI was created using CreateImage, CopyImage, or CreateRestoreImageTask. The Region does not appear if the AMI was created using any other API. For some older AMIs, the Region might not be available. For more information, see Identify the source AMI used to create a new Amazon EC2 AMI in the Amazon EC2 User Guide.

Source

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

The Region of the source AMI.

The Region only appears if the AMI was created using CreateImage, CopyImage, or CreateRestoreImageTask. The Region does not appear if the AMI was created using any other API. For some older AMIs, the Region might not be available. For more information, see Identify the source AMI used to create a new Amazon EC2 AMI in the Amazon EC2 User Guide.

Source

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

The ID of the AMI.

Source

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

The ID of the AMI.

Source

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

The ID of the AMI.

Source

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

The location of the AMI.

Source

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

The location of the AMI.

Source

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

The location of the AMI.

Source

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

The current state of the AMI. If the state is available, the image is successfully registered and can be used to launch an instance.

Source

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

The current state of the AMI. If the state is available, the image is successfully registered and can be used to launch an instance.

Source

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

The current state of the AMI. If the state is available, the image is successfully registered and can be used to launch an instance.

Source

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

The ID of the Amazon Web Services account that owns the image.

Source

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

The ID of the Amazon Web Services account that owns the image.

Source

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

The ID of the Amazon Web Services account that owns the image.

Source

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

The date and time the image was created.

Source

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

The date and time the image was created.

Source

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

The date and time the image was created.

Source

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

Indicates whether the image has public launch permissions. The value is true if this image has public launch permissions or false if it has only implicit and explicit launch permissions.

Source

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

Indicates whether the image has public launch permissions. The value is true if this image has public launch permissions or false if it has only implicit and explicit launch permissions.

Source

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

Indicates whether the image has public launch permissions. The value is true if this image has public launch permissions or false if it has only implicit and explicit launch permissions.

Source

pub fn product_codes(self, input: ProductCode) -> Self

Appends an item to product_codes.

To override the contents of this collection use set_product_codes.

Any product codes associated with the AMI.

Source

pub fn set_product_codes(self, input: Option<Vec<ProductCode>>) -> Self

Any product codes associated with the AMI.

Source

pub fn get_product_codes(&self) -> &Option<Vec<ProductCode>>

Any product codes associated with the AMI.

Source

pub fn architecture(self, input: ArchitectureValues) -> Self

The architecture of the image.

Source

pub fn set_architecture(self, input: Option<ArchitectureValues>) -> Self

The architecture of the image.

Source

pub fn get_architecture(&self) -> &Option<ArchitectureValues>

The architecture of the image.

Source

pub fn image_type(self, input: ImageTypeValues) -> Self

The type of image.

Source

pub fn set_image_type(self, input: Option<ImageTypeValues>) -> Self

The type of image.

Source

pub fn get_image_type(&self) -> &Option<ImageTypeValues>

The type of image.

Source

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

The kernel associated with the image, if any. Only applicable for machine images.

Source

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

The kernel associated with the image, if any. Only applicable for machine images.

Source

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

The kernel associated with the image, if any. Only applicable for machine images.

Source

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

The RAM disk associated with the image, if any. Only applicable for machine images.

Source

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

The RAM disk associated with the image, if any. Only applicable for machine images.

Source

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

The RAM disk associated with the image, if any. Only applicable for machine images.

Source

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

This value is set to windows for Windows AMIs; otherwise, it is blank.

Source

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

This value is set to windows for Windows AMIs; otherwise, it is blank.

Source

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

This value is set to windows for Windows AMIs; otherwise, it is blank.

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§

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,