aws_sdk_sagemaker::types::builders

Struct ModelPackageBuilder

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

A builder for ModelPackage.

Implementations§

Source§

impl ModelPackageBuilder

Source

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

The name of the model package. The name can be as follows:

  • For a versioned model, the name is automatically generated by SageMaker Model Registry and follows the format 'ModelPackageGroupName/ModelPackageVersion'.

  • For an unversioned model, you must provide the name.

Source

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

The name of the model package. The name can be as follows:

  • For a versioned model, the name is automatically generated by SageMaker Model Registry and follows the format 'ModelPackageGroupName/ModelPackageVersion'.

  • For an unversioned model, you must provide the name.

Source

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

The name of the model package. The name can be as follows:

  • For a versioned model, the name is automatically generated by SageMaker Model Registry and follows the format 'ModelPackageGroupName/ModelPackageVersion'.

  • For an unversioned model, you must provide the name.

Source

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

The model group to which the model belongs.

Source

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

The model group to which the model belongs.

Source

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

The model group to which the model belongs.

Source

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

The version number of a versioned model.

Source

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

The version number of a versioned model.

Source

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

The version number of a versioned model.

Source

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

The Amazon Resource Name (ARN) of the model package.

Source

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

The Amazon Resource Name (ARN) of the model package.

Source

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

The Amazon Resource Name (ARN) of the model package.

Source

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

The description of the model package.

Source

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

The description of the model package.

Source

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

The description of the model package.

Source

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

The time that the model package was created.

Source

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

The time that the model package was created.

Source

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

The time that the model package was created.

Source

pub fn inference_specification(self, input: InferenceSpecification) -> Self

Defines how to perform inference generation after a training job is run.

Source

pub fn set_inference_specification( self, input: Option<InferenceSpecification>, ) -> Self

Defines how to perform inference generation after a training job is run.

Source

pub fn get_inference_specification(&self) -> &Option<InferenceSpecification>

Defines how to perform inference generation after a training job is run.

Source

pub fn source_algorithm_specification( self, input: SourceAlgorithmSpecification, ) -> Self

A list of algorithms that were used to create a model package.

Source

pub fn set_source_algorithm_specification( self, input: Option<SourceAlgorithmSpecification>, ) -> Self

A list of algorithms that were used to create a model package.

Source

pub fn get_source_algorithm_specification( &self, ) -> &Option<SourceAlgorithmSpecification>

A list of algorithms that were used to create a model package.

Source

pub fn validation_specification( self, input: ModelPackageValidationSpecification, ) -> Self

Specifies batch transform jobs that SageMaker runs to validate your model package.

Source

pub fn set_validation_specification( self, input: Option<ModelPackageValidationSpecification>, ) -> Self

Specifies batch transform jobs that SageMaker runs to validate your model package.

Source

pub fn get_validation_specification( &self, ) -> &Option<ModelPackageValidationSpecification>

Specifies batch transform jobs that SageMaker runs to validate your model package.

Source

pub fn model_package_status(self, input: ModelPackageStatus) -> Self

The status of the model package. This can be one of the following values.

  • PENDING - The model package is pending being created.

  • IN_PROGRESS - The model package is in the process of being created.

  • COMPLETED - The model package was successfully created.

  • FAILED - The model package failed.

  • DELETING - The model package is in the process of being deleted.

Source

pub fn set_model_package_status(self, input: Option<ModelPackageStatus>) -> Self

The status of the model package. This can be one of the following values.

  • PENDING - The model package is pending being created.

  • IN_PROGRESS - The model package is in the process of being created.

  • COMPLETED - The model package was successfully created.

  • FAILED - The model package failed.

  • DELETING - The model package is in the process of being deleted.

Source

pub fn get_model_package_status(&self) -> &Option<ModelPackageStatus>

The status of the model package. This can be one of the following values.

  • PENDING - The model package is pending being created.

  • IN_PROGRESS - The model package is in the process of being created.

  • COMPLETED - The model package was successfully created.

  • FAILED - The model package failed.

  • DELETING - The model package is in the process of being deleted.

Source

pub fn model_package_status_details( self, input: ModelPackageStatusDetails, ) -> Self

Specifies the validation and image scan statuses of the model package.

Source

pub fn set_model_package_status_details( self, input: Option<ModelPackageStatusDetails>, ) -> Self

Specifies the validation and image scan statuses of the model package.

Source

pub fn get_model_package_status_details( &self, ) -> &Option<ModelPackageStatusDetails>

Specifies the validation and image scan statuses of the model package.

Source

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

Whether the model package is to be certified to be listed on Amazon Web Services Marketplace. For information about listing model packages on Amazon Web Services Marketplace, see List Your Algorithm or Model Package on Amazon Web Services Marketplace.

Source

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

Whether the model package is to be certified to be listed on Amazon Web Services Marketplace. For information about listing model packages on Amazon Web Services Marketplace, see List Your Algorithm or Model Package on Amazon Web Services Marketplace.

Source

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

Whether the model package is to be certified to be listed on Amazon Web Services Marketplace. For information about listing model packages on Amazon Web Services Marketplace, see List Your Algorithm or Model Package on Amazon Web Services Marketplace.

Source

pub fn model_approval_status(self, input: ModelApprovalStatus) -> Self

The approval status of the model. This can be one of the following values.

  • APPROVED - The model is approved

  • REJECTED - The model is rejected.

  • PENDING_MANUAL_APPROVAL - The model is waiting for manual approval.

Source

pub fn set_model_approval_status( self, input: Option<ModelApprovalStatus>, ) -> Self

The approval status of the model. This can be one of the following values.

  • APPROVED - The model is approved

  • REJECTED - The model is rejected.

  • PENDING_MANUAL_APPROVAL - The model is waiting for manual approval.

Source

pub fn get_model_approval_status(&self) -> &Option<ModelApprovalStatus>

The approval status of the model. This can be one of the following values.

  • APPROVED - The model is approved

  • REJECTED - The model is rejected.

  • PENDING_MANUAL_APPROVAL - The model is waiting for manual approval.

Source

pub fn created_by(self, input: UserContext) -> Self

Information about the user who created or modified an experiment, trial, trial component, lineage group, or project.

Source

pub fn set_created_by(self, input: Option<UserContext>) -> Self

Information about the user who created or modified an experiment, trial, trial component, lineage group, or project.

Source

pub fn get_created_by(&self) -> &Option<UserContext>

Information about the user who created or modified an experiment, trial, trial component, lineage group, or project.

Source

pub fn metadata_properties(self, input: MetadataProperties) -> Self

Metadata properties of the tracking entity, trial, or trial component.

Source

pub fn set_metadata_properties(self, input: Option<MetadataProperties>) -> Self

Metadata properties of the tracking entity, trial, or trial component.

Source

pub fn get_metadata_properties(&self) -> &Option<MetadataProperties>

Metadata properties of the tracking entity, trial, or trial component.

Source

pub fn model_metrics(self, input: ModelMetrics) -> Self

Metrics for the model.

Source

pub fn set_model_metrics(self, input: Option<ModelMetrics>) -> Self

Metrics for the model.

Source

pub fn get_model_metrics(&self) -> &Option<ModelMetrics>

Metrics for the model.

Source

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

The last time the model package was modified.

Source

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

The last time the model package was modified.

Source

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

The last time the model package was modified.

Source

pub fn last_modified_by(self, input: UserContext) -> Self

Information about the user who created or modified an experiment, trial, trial component, lineage group, or project.

Source

pub fn set_last_modified_by(self, input: Option<UserContext>) -> Self

Information about the user who created or modified an experiment, trial, trial component, lineage group, or project.

Source

pub fn get_last_modified_by(&self) -> &Option<UserContext>

Information about the user who created or modified an experiment, trial, trial component, lineage group, or project.

Source

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

A description provided when the model approval is set.

Source

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

A description provided when the model approval is set.

Source

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

A description provided when the model approval is set.

Source

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

The machine learning domain of your model package and its components. Common machine learning domains include computer vision and natural language processing.

Source

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

The machine learning domain of your model package and its components. Common machine learning domains include computer vision and natural language processing.

Source

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

The machine learning domain of your model package and its components. Common machine learning domains include computer vision and natural language processing.

Source

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

The machine learning task your model package accomplishes. Common machine learning tasks include object detection and image classification.

Source

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

The machine learning task your model package accomplishes. Common machine learning tasks include object detection and image classification.

Source

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

The machine learning task your model package accomplishes. Common machine learning tasks include object detection and image classification.

Source

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

The Amazon Simple Storage Service path where the sample payload are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).

Source

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

The Amazon Simple Storage Service path where the sample payload are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).

Source

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

The Amazon Simple Storage Service path where the sample payload are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).

Source

pub fn additional_inference_specifications( self, input: AdditionalInferenceSpecificationDefinition, ) -> Self

Appends an item to additional_inference_specifications.

To override the contents of this collection use set_additional_inference_specifications.

An array of additional Inference Specification objects.

Source

pub fn set_additional_inference_specifications( self, input: Option<Vec<AdditionalInferenceSpecificationDefinition>>, ) -> Self

An array of additional Inference Specification objects.

Source

pub fn get_additional_inference_specifications( &self, ) -> &Option<Vec<AdditionalInferenceSpecificationDefinition>>

An array of additional Inference Specification objects.

Source

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

The URI of the source for the model package.

Source

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

The URI of the source for the model package.

Source

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

The URI of the source for the model package.

Source

pub fn security_config(self, input: ModelPackageSecurityConfig) -> Self

An optional Key Management Service key to encrypt, decrypt, and re-encrypt model package information for regulated workloads with highly sensitive data.

Source

pub fn set_security_config( self, input: Option<ModelPackageSecurityConfig>, ) -> Self

An optional Key Management Service key to encrypt, decrypt, and re-encrypt model package information for regulated workloads with highly sensitive data.

Source

pub fn get_security_config(&self) -> &Option<ModelPackageSecurityConfig>

An optional Key Management Service key to encrypt, decrypt, and re-encrypt model package information for regulated workloads with highly sensitive data.

Source

pub fn model_card(self, input: ModelPackageModelCard) -> Self

The model card associated with the model package. Since ModelPackageModelCard is tied to a model package, it is a specific usage of a model card and its schema is simplified compared to the schema of ModelCard. The ModelPackageModelCard schema does not include model_package_details, and model_overview is composed of the model_creator and model_artifact properties. For more information about the model package model card schema, see Model package model card schema. For more information about the model card associated with the model package, see View the Details of a Model Version.

Source

pub fn set_model_card(self, input: Option<ModelPackageModelCard>) -> Self

The model card associated with the model package. Since ModelPackageModelCard is tied to a model package, it is a specific usage of a model card and its schema is simplified compared to the schema of ModelCard. The ModelPackageModelCard schema does not include model_package_details, and model_overview is composed of the model_creator and model_artifact properties. For more information about the model package model card schema, see Model package model card schema. For more information about the model card associated with the model package, see View the Details of a Model Version.

Source

pub fn get_model_card(&self) -> &Option<ModelPackageModelCard>

The model card associated with the model package. Since ModelPackageModelCard is tied to a model package, it is a specific usage of a model card and its schema is simplified compared to the schema of ModelCard. The ModelPackageModelCard schema does not include model_package_details, and model_overview is composed of the model_creator and model_artifact properties. For more information about the model package model card schema, see Model package model card schema. For more information about the model card associated with the model package, see View the Details of a Model Version.

Source

pub fn model_life_cycle(self, input: ModelLifeCycle) -> Self

A structure describing the current state of the model in its life cycle.

Source

pub fn set_model_life_cycle(self, input: Option<ModelLifeCycle>) -> Self

A structure describing the current state of the model in its life cycle.

Source

pub fn get_model_life_cycle(&self) -> &Option<ModelLifeCycle>

A structure describing the current state of the model in its life cycle.

Source

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

Appends an item to tags.

To override the contents of this collection use set_tags.

A list of the tags associated with the model package. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

Source

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

A list of the tags associated with the model package. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

Source

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

A list of the tags associated with the model package. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

Source

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

Adds a key-value pair to customer_metadata_properties.

To override the contents of this collection use set_customer_metadata_properties.

The metadata properties for the model package.

Source

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

The metadata properties for the model package.

Source

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

The metadata properties for the model package.

Source

pub fn drift_check_baselines(self, input: DriftCheckBaselines) -> Self

Represents the drift check baselines that can be used when the model monitor is set using the model package.

Source

pub fn set_drift_check_baselines( self, input: Option<DriftCheckBaselines>, ) -> Self

Represents the drift check baselines that can be used when the model monitor is set using the model package.

Source

pub fn get_drift_check_baselines(&self) -> &Option<DriftCheckBaselines>

Represents the drift check baselines that can be used when the model monitor is set using the model package.

Source

pub fn skip_model_validation(self, input: SkipModelValidation) -> Self

Indicates if you want to skip model validation.

Source

pub fn set_skip_model_validation( self, input: Option<SkipModelValidation>, ) -> Self

Indicates if you want to skip model validation.

Source

pub fn get_skip_model_validation(&self) -> &Option<SkipModelValidation>

Indicates if you want to skip model validation.

Source

pub fn build(self) -> ModelPackage

Consumes the builder and constructs a ModelPackage.

Trait Implementations§

Source§

impl Clone for ModelPackageBuilder

Source§

fn clone(&self) -> ModelPackageBuilder

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 ModelPackageBuilder

Source§

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

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

impl Default for ModelPackageBuilder

Source§

fn default() -> ModelPackageBuilder

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

impl PartialEq for ModelPackageBuilder

Source§

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

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,