Struct Build

Source
#[non_exhaustive]
pub struct Build {
Show 33 fields pub id: Option<String>, pub arn: Option<String>, pub build_number: Option<i64>, pub start_time: Option<DateTime>, pub end_time: Option<DateTime>, pub current_phase: Option<String>, pub build_status: Option<StatusType>, pub source_version: Option<String>, pub resolved_source_version: Option<String>, pub project_name: Option<String>, pub phases: Option<Vec<BuildPhase>>, pub source: Option<ProjectSource>, pub secondary_sources: Option<Vec<ProjectSource>>, pub secondary_source_versions: Option<Vec<ProjectSourceVersion>>, pub artifacts: Option<BuildArtifacts>, pub secondary_artifacts: Option<Vec<BuildArtifacts>>, pub cache: Option<ProjectCache>, pub environment: Option<ProjectEnvironment>, pub service_role: Option<String>, pub logs: Option<LogsLocation>, pub timeout_in_minutes: Option<i32>, pub queued_timeout_in_minutes: Option<i32>, pub build_complete: bool, pub initiator: Option<String>, pub vpc_config: Option<VpcConfig>, pub network_interface: Option<NetworkInterface>, pub encryption_key: Option<String>, pub exported_environment_variables: Option<Vec<ExportedEnvironmentVariable>>, pub report_arns: Option<Vec<String>>, pub file_system_locations: Option<Vec<ProjectFileSystemLocation>>, pub debug_session: Option<DebugSession>, pub build_batch_arn: Option<String>, pub auto_retry_config: Option<AutoRetryConfig>,
}
Expand description

Information about a build.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§id: Option<String>

The unique ID for the build.

§arn: Option<String>

The Amazon Resource Name (ARN) of the build.

§build_number: Option<i64>

The number of the build. For each project, the buildNumber of its first build is 1. The buildNumber of each subsequent build is incremented by 1. If a build is deleted, the buildNumber of other builds does not change.

§start_time: Option<DateTime>

When the build process started, expressed in Unix time format.

§end_time: Option<DateTime>

When the build process ended, expressed in Unix time format.

§current_phase: Option<String>

The current build phase.

§build_status: Option<StatusType>

The current status of the build. Valid values include:

  • FAILED: The build failed.

  • FAULT: The build faulted.

  • IN_PROGRESS: The build is still in progress.

  • STOPPED: The build stopped.

  • SUCCEEDED: The build succeeded.

  • TIMED_OUT: The build timed out.

§source_version: Option<String>

Any version identifier for the version of the source code to be built. If sourceVersion is specified at the project level, then this sourceVersion (at the build level) takes precedence.

For more information, see Source Version Sample with CodeBuild in the CodeBuild User Guide.

§resolved_source_version: Option<String>

An identifier for the version of this build's source code.

  • For CodeCommit, GitHub, GitHub Enterprise, and BitBucket, the commit ID.

  • For CodePipeline, the source revision provided by CodePipeline.

  • For Amazon S3, this does not apply.

§project_name: Option<String>

The name of the CodeBuild project.

§phases: Option<Vec<BuildPhase>>

Information about all previous build phases that are complete and information about any current build phase that is not yet complete.

§source: Option<ProjectSource>

Information about the source code to be built.

§secondary_sources: Option<Vec<ProjectSource>>

An array of ProjectSource objects.

§secondary_source_versions: Option<Vec<ProjectSourceVersion>>

An array of ProjectSourceVersion objects. Each ProjectSourceVersion must be one of:

  • For CodeCommit: the commit ID, branch, or Git tag to use.

  • For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example, pr/25). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.

  • For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.

  • For Amazon S3: the version ID of the object that represents the build input ZIP file to use.

§artifacts: Option<BuildArtifacts>

Information about the output artifacts for the build.

§secondary_artifacts: Option<Vec<BuildArtifacts>>

An array of ProjectArtifacts objects.

§cache: Option<ProjectCache>

Information about the cache for the build.

§environment: Option<ProjectEnvironment>

Information about the build environment for this build.

§service_role: Option<String>

The name of a service role used for this build.

§logs: Option<LogsLocation>

Information about the build's logs in CloudWatch Logs.

§timeout_in_minutes: Option<i32>

How long, in minutes, from 5 to 2160 (36 hours), for CodeBuild to wait before timing out this build if it does not get marked as completed.

§queued_timeout_in_minutes: Option<i32>

The number of minutes a build is allowed to be queued before it times out.

§build_complete: bool

Whether the build is complete. True if complete; otherwise, false.

§initiator: Option<String>

The entity that started the build. Valid values include:

  • If CodePipeline started the build, the pipeline's name (for example, codepipeline/my-demo-pipeline).

  • If a user started the build, the user's name (for example, MyUserName).

  • If the Jenkins plugin for CodeBuild started the build, the string CodeBuild-Jenkins-Plugin.

§vpc_config: Option<VpcConfig>

If your CodeBuild project accesses resources in an Amazon VPC, you provide this parameter that identifies the VPC ID and the list of security group IDs and subnet IDs. The security groups and subnets must belong to the same VPC. You must provide at least one security group and one subnet ID.

§network_interface: Option<NetworkInterface>

Describes a network interface.

§encryption_key: Option<String>

The Key Management Service customer master key (CMK) to be used for encrypting the build output artifacts.

You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.

You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format alias/).

§exported_environment_variables: Option<Vec<ExportedEnvironmentVariable>>

A list of exported environment variables for this build.

Exported environment variables are used in conjunction with CodePipeline to export environment variables from the current build stage to subsequent stages in the pipeline. For more information, see Working with variables in the CodePipeline User Guide.

§report_arns: Option<Vec<String>>

An array of the ARNs associated with this build's reports.

§file_system_locations: Option<Vec<ProjectFileSystemLocation>>

An array of ProjectFileSystemLocation objects for a CodeBuild build project. A ProjectFileSystemLocation object specifies the identifier, location, mountOptions, mountPoint, and type of a file system created using Amazon Elastic File System.

§debug_session: Option<DebugSession>

Contains information about the debug session for this build.

§build_batch_arn: Option<String>

The ARN of the batch build that this build is a member of, if applicable.

§auto_retry_config: Option<AutoRetryConfig>

Information about the auto-retry configuration for the build.

Implementations§

Source§

impl Build

Source

pub fn id(&self) -> Option<&str>

The unique ID for the build.

Source

pub fn arn(&self) -> Option<&str>

The Amazon Resource Name (ARN) of the build.

Source

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

The number of the build. For each project, the buildNumber of its first build is 1. The buildNumber of each subsequent build is incremented by 1. If a build is deleted, the buildNumber of other builds does not change.

Source

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

When the build process started, expressed in Unix time format.

Source

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

When the build process ended, expressed in Unix time format.

Source

pub fn current_phase(&self) -> Option<&str>

The current build phase.

Source

pub fn build_status(&self) -> Option<&StatusType>

The current status of the build. Valid values include:

  • FAILED: The build failed.

  • FAULT: The build faulted.

  • IN_PROGRESS: The build is still in progress.

  • STOPPED: The build stopped.

  • SUCCEEDED: The build succeeded.

  • TIMED_OUT: The build timed out.

Source

pub fn source_version(&self) -> Option<&str>

Any version identifier for the version of the source code to be built. If sourceVersion is specified at the project level, then this sourceVersion (at the build level) takes precedence.

For more information, see Source Version Sample with CodeBuild in the CodeBuild User Guide.

Source

pub fn resolved_source_version(&self) -> Option<&str>

An identifier for the version of this build's source code.

  • For CodeCommit, GitHub, GitHub Enterprise, and BitBucket, the commit ID.

  • For CodePipeline, the source revision provided by CodePipeline.

  • For Amazon S3, this does not apply.

Source

pub fn project_name(&self) -> Option<&str>

The name of the CodeBuild project.

Source

pub fn phases(&self) -> &[BuildPhase]

Information about all previous build phases that are complete and information about any current build phase that is not yet complete.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .phases.is_none().

Source

pub fn source(&self) -> Option<&ProjectSource>

Information about the source code to be built.

Source

pub fn secondary_sources(&self) -> &[ProjectSource]

An array of ProjectSource objects.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .secondary_sources.is_none().

Source

pub fn secondary_source_versions(&self) -> &[ProjectSourceVersion]

An array of ProjectSourceVersion objects. Each ProjectSourceVersion must be one of:

  • For CodeCommit: the commit ID, branch, or Git tag to use.

  • For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example, pr/25). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.

  • For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.

  • For Amazon S3: the version ID of the object that represents the build input ZIP file to use.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .secondary_source_versions.is_none().

Source

pub fn artifacts(&self) -> Option<&BuildArtifacts>

Information about the output artifacts for the build.

Source

pub fn secondary_artifacts(&self) -> &[BuildArtifacts]

An array of ProjectArtifacts objects.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .secondary_artifacts.is_none().

Source

pub fn cache(&self) -> Option<&ProjectCache>

Information about the cache for the build.

Source

pub fn environment(&self) -> Option<&ProjectEnvironment>

Information about the build environment for this build.

Source

pub fn service_role(&self) -> Option<&str>

The name of a service role used for this build.

Source

pub fn logs(&self) -> Option<&LogsLocation>

Information about the build's logs in CloudWatch Logs.

Source

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

How long, in minutes, from 5 to 2160 (36 hours), for CodeBuild to wait before timing out this build if it does not get marked as completed.

Source

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

The number of minutes a build is allowed to be queued before it times out.

Source

pub fn build_complete(&self) -> bool

Whether the build is complete. True if complete; otherwise, false.

Source

pub fn initiator(&self) -> Option<&str>

The entity that started the build. Valid values include:

  • If CodePipeline started the build, the pipeline's name (for example, codepipeline/my-demo-pipeline).

  • If a user started the build, the user's name (for example, MyUserName).

  • If the Jenkins plugin for CodeBuild started the build, the string CodeBuild-Jenkins-Plugin.

Source

pub fn vpc_config(&self) -> Option<&VpcConfig>

If your CodeBuild project accesses resources in an Amazon VPC, you provide this parameter that identifies the VPC ID and the list of security group IDs and subnet IDs. The security groups and subnets must belong to the same VPC. You must provide at least one security group and one subnet ID.

Source

pub fn network_interface(&self) -> Option<&NetworkInterface>

Describes a network interface.

Source

pub fn encryption_key(&self) -> Option<&str>

The Key Management Service customer master key (CMK) to be used for encrypting the build output artifacts.

You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.

You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format alias/).

Source

pub fn exported_environment_variables(&self) -> &[ExportedEnvironmentVariable]

A list of exported environment variables for this build.

Exported environment variables are used in conjunction with CodePipeline to export environment variables from the current build stage to subsequent stages in the pipeline. For more information, see Working with variables in the CodePipeline User Guide.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .exported_environment_variables.is_none().

Source

pub fn report_arns(&self) -> &[String]

An array of the ARNs associated with this build's reports.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .report_arns.is_none().

Source

pub fn file_system_locations(&self) -> &[ProjectFileSystemLocation]

An array of ProjectFileSystemLocation objects for a CodeBuild build project. A ProjectFileSystemLocation object specifies the identifier, location, mountOptions, mountPoint, and type of a file system created using Amazon Elastic File System.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .file_system_locations.is_none().

Source

pub fn debug_session(&self) -> Option<&DebugSession>

Contains information about the debug session for this build.

Source

pub fn build_batch_arn(&self) -> Option<&str>

The ARN of the batch build that this build is a member of, if applicable.

Source

pub fn auto_retry_config(&self) -> Option<&AutoRetryConfig>

Information about the auto-retry configuration for the build.

Source§

impl Build

Source

pub fn builder() -> BuildBuilder

Creates a new builder-style object to manufacture Build.

Trait Implementations§

Source§

impl Clone for Build

Source§

fn clone(&self) -> Build

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 Build

Source§

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

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

impl PartialEq for Build

Source§

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

Auto Trait Implementations§

§

impl Freeze for Build

§

impl RefUnwindSafe for Build

§

impl Send for Build

§

impl Sync for Build

§

impl Unpin for Build

§

impl UnwindSafe for Build

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,