aws_sdk_codebuild::operation::start_build_batch::builders

Struct StartBuildBatchFluentBuilder

Source 
pub struct StartBuildBatchFluentBuilder { /* private fields */ }
Expand description

Fluent builder constructing a request to StartBuildBatch.

Starts a batch build for a project.

Implementations§

Source§

impl StartBuildBatchFluentBuilder

Source

pub fn as_input(&self) -> &StartBuildBatchInputBuilder

Access the StartBuildBatch as a reference.

Source

pub async fn send( self, ) -> Result<StartBuildBatchOutput, SdkError<StartBuildBatchError, HttpResponse>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

Source

pub fn customize( self, ) -> CustomizableOperation<StartBuildBatchOutput, StartBuildBatchError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

Source

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

The name of the project.

Source

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

The name of the project.

Source

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

The name of the project.

Source

pub fn secondary_sources_override(self, input: ProjectSource) -> Self

Appends an item to secondarySourcesOverride.

To override the contents of this collection use set_secondary_sources_override.

An array of ProjectSource objects that override the secondary sources defined in the batch build project.

Source

pub fn set_secondary_sources_override( self, input: Option<Vec<ProjectSource>>, ) -> Self

An array of ProjectSource objects that override the secondary sources defined in the batch build project.

Source

pub fn get_secondary_sources_override(&self) -> &Option<Vec<ProjectSource>>

An array of ProjectSource objects that override the secondary sources defined in the batch build project.

Source

pub fn secondary_sources_version_override( self, input: ProjectSourceVersion, ) -> Self

Appends an item to secondarySourcesVersionOverride.

To override the contents of this collection use set_secondary_sources_version_override.

An array of ProjectSourceVersion objects that override the secondary source versions in the batch build project.

Source

pub fn set_secondary_sources_version_override( self, input: Option<Vec<ProjectSourceVersion>>, ) -> Self

An array of ProjectSourceVersion objects that override the secondary source versions in the batch build project.

Source

pub fn get_secondary_sources_version_override( &self, ) -> &Option<Vec<ProjectSourceVersion>>

An array of ProjectSourceVersion objects that override the secondary source versions in the batch build project.

Source

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

The version of the batch build input to be built, for this build only. If not specified, the latest version is used. If specified, the contents depends on the source provider:

CodeCommit

The commit ID, branch, or Git tag to use.

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.

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.

Amazon S3

The version ID of the object that represents the build input ZIP file to use.

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 set_source_version(self, input: Option<String>) -> Self

The version of the batch build input to be built, for this build only. If not specified, the latest version is used. If specified, the contents depends on the source provider:

CodeCommit

The commit ID, branch, or Git tag to use.

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.

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.

Amazon S3

The version ID of the object that represents the build input ZIP file to use.

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 get_source_version(&self) -> &Option<String>

The version of the batch build input to be built, for this build only. If not specified, the latest version is used. If specified, the contents depends on the source provider:

CodeCommit

The commit ID, branch, or Git tag to use.

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.

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.

Amazon S3

The version ID of the object that represents the build input ZIP file to use.

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 artifacts_override(self, input: ProjectArtifacts) -> Self

An array of ProjectArtifacts objects that contains information about the build output artifact overrides for the build project.

Source

pub fn set_artifacts_override(self, input: Option<ProjectArtifacts>) -> Self

An array of ProjectArtifacts objects that contains information about the build output artifact overrides for the build project.

Source

pub fn get_artifacts_override(&self) -> &Option<ProjectArtifacts>

An array of ProjectArtifacts objects that contains information about the build output artifact overrides for the build project.

Source

pub fn secondary_artifacts_override(self, input: ProjectArtifacts) -> Self

Appends an item to secondaryArtifactsOverride.

To override the contents of this collection use set_secondary_artifacts_override.

An array of ProjectArtifacts objects that override the secondary artifacts defined in the batch build project.

Source

pub fn set_secondary_artifacts_override( self, input: Option<Vec<ProjectArtifacts>>, ) -> Self

An array of ProjectArtifacts objects that override the secondary artifacts defined in the batch build project.

Source

pub fn get_secondary_artifacts_override(&self) -> &Option<Vec<ProjectArtifacts>>

An array of ProjectArtifacts objects that override the secondary artifacts defined in the batch build project.

Source

pub fn environment_variables_override(self, input: EnvironmentVariable) -> Self

Appends an item to environmentVariablesOverride.

To override the contents of this collection use set_environment_variables_override.

An array of EnvironmentVariable objects that override, or add to, the environment variables defined in the batch build project.

Source

pub fn set_environment_variables_override( self, input: Option<Vec<EnvironmentVariable>>, ) -> Self

An array of EnvironmentVariable objects that override, or add to, the environment variables defined in the batch build project.

Source

pub fn get_environment_variables_override( &self, ) -> &Option<Vec<EnvironmentVariable>>

An array of EnvironmentVariable objects that override, or add to, the environment variables defined in the batch build project.

Source

pub fn source_type_override(self, input: SourceType) -> Self

The source input type that overrides the source input defined in the batch build project.

Source

pub fn set_source_type_override(self, input: Option<SourceType>) -> Self

The source input type that overrides the source input defined in the batch build project.

Source

pub fn get_source_type_override(&self) -> &Option<SourceType>

The source input type that overrides the source input defined in the batch build project.

Source

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

A location that overrides, for this batch build, the source location defined in the batch build project.

Source

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

A location that overrides, for this batch build, the source location defined in the batch build project.

Source

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

A location that overrides, for this batch build, the source location defined in the batch build project.

Source

pub fn source_auth_override(self, input: SourceAuth) -> Self

A SourceAuth object that overrides the one defined in the batch build project. This override applies only if the build project's source is BitBucket or GitHub.

Source

pub fn set_source_auth_override(self, input: Option<SourceAuth>) -> Self

A SourceAuth object that overrides the one defined in the batch build project. This override applies only if the build project's source is BitBucket or GitHub.

Source

pub fn get_source_auth_override(&self) -> &Option<SourceAuth>

A SourceAuth object that overrides the one defined in the batch build project. This override applies only if the build project's source is BitBucket or GitHub.

Source

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

The user-defined depth of history, with a minimum value of 0, that overrides, for this batch build only, any previous depth of history defined in the batch build project.

Source

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

The user-defined depth of history, with a minimum value of 0, that overrides, for this batch build only, any previous depth of history defined in the batch build project.

Source

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

The user-defined depth of history, with a minimum value of 0, that overrides, for this batch build only, any previous depth of history defined in the batch build project.

Source

pub fn git_submodules_config_override(self, input: GitSubmodulesConfig) -> Self

A GitSubmodulesConfig object that overrides the Git submodules configuration for this batch build.

Source

pub fn set_git_submodules_config_override( self, input: Option<GitSubmodulesConfig>, ) -> Self

A GitSubmodulesConfig object that overrides the Git submodules configuration for this batch build.

Source

pub fn get_git_submodules_config_override(&self) -> &Option<GitSubmodulesConfig>

A GitSubmodulesConfig object that overrides the Git submodules configuration for this batch build.

Source

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

A buildspec file declaration that overrides, for this build only, the latest one already defined in the build project.

If this value is set, it can be either an inline buildspec definition, the path to an alternate buildspec file relative to the value of the built-in CODEBUILD_SRC_DIR environment variable, or the path to an S3 bucket. The bucket must be in the same Amazon Web Services Region as the build project. Specify the buildspec file using its ARN (for example, arn:aws:s3:::my-codebuild-sample2/buildspec.yml). If this value is not provided or is set to an empty string, the source code must contain a buildspec file in its root directory. For more information, see Buildspec File Name and Storage Location.

Source

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

A buildspec file declaration that overrides, for this build only, the latest one already defined in the build project.

If this value is set, it can be either an inline buildspec definition, the path to an alternate buildspec file relative to the value of the built-in CODEBUILD_SRC_DIR environment variable, or the path to an S3 bucket. The bucket must be in the same Amazon Web Services Region as the build project. Specify the buildspec file using its ARN (for example, arn:aws:s3:::my-codebuild-sample2/buildspec.yml). If this value is not provided or is set to an empty string, the source code must contain a buildspec file in its root directory. For more information, see Buildspec File Name and Storage Location.

Source

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

A buildspec file declaration that overrides, for this build only, the latest one already defined in the build project.

If this value is set, it can be either an inline buildspec definition, the path to an alternate buildspec file relative to the value of the built-in CODEBUILD_SRC_DIR environment variable, or the path to an S3 bucket. The bucket must be in the same Amazon Web Services Region as the build project. Specify the buildspec file using its ARN (for example, arn:aws:s3:::my-codebuild-sample2/buildspec.yml). If this value is not provided or is set to an empty string, the source code must contain a buildspec file in its root directory. For more information, see Buildspec File Name and Storage Location.

Source

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

Enable this flag to override the insecure SSL setting that is specified in the batch build project. The insecure SSL setting determines whether to ignore SSL warnings while connecting to the project source code. This override applies only if the build's source is GitHub Enterprise.

Source

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

Enable this flag to override the insecure SSL setting that is specified in the batch build project. The insecure SSL setting determines whether to ignore SSL warnings while connecting to the project source code. This override applies only if the build's source is GitHub Enterprise.

Source

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

Enable this flag to override the insecure SSL setting that is specified in the batch build project. The insecure SSL setting determines whether to ignore SSL warnings while connecting to the project source code. This override applies only if the build's source is GitHub Enterprise.

Source

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

Set to true to report to your source provider the status of a batch build's start and completion. If you use this option with a source provider other than GitHub, GitHub Enterprise, or Bitbucket, an invalidInputException is thrown.

The status of a build triggered by a webhook is always reported to your source provider.

Source

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

Set to true to report to your source provider the status of a batch build's start and completion. If you use this option with a source provider other than GitHub, GitHub Enterprise, or Bitbucket, an invalidInputException is thrown.

The status of a build triggered by a webhook is always reported to your source provider.

Source

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

Set to true to report to your source provider the status of a batch build's start and completion. If you use this option with a source provider other than GitHub, GitHub Enterprise, or Bitbucket, an invalidInputException is thrown.

The status of a build triggered by a webhook is always reported to your source provider.

Source

pub fn environment_type_override(self, input: EnvironmentType) -> Self

A container type for this batch build that overrides the one specified in the batch build project.

Source

pub fn set_environment_type_override( self, input: Option<EnvironmentType>, ) -> Self

A container type for this batch build that overrides the one specified in the batch build project.

Source

pub fn get_environment_type_override(&self) -> &Option<EnvironmentType>

A container type for this batch build that overrides the one specified in the batch build project.

Source

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

The name of an image for this batch build that overrides the one specified in the batch build project.

Source

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

The name of an image for this batch build that overrides the one specified in the batch build project.

Source

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

The name of an image for this batch build that overrides the one specified in the batch build project.

Source

pub fn compute_type_override(self, input: ComputeType) -> Self

The name of a compute type for this batch build that overrides the one specified in the batch build project.

Source

pub fn set_compute_type_override(self, input: Option<ComputeType>) -> Self

The name of a compute type for this batch build that overrides the one specified in the batch build project.

Source

pub fn get_compute_type_override(&self) -> &Option<ComputeType>

The name of a compute type for this batch build that overrides the one specified in the batch build project.

Source

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

The name of a certificate for this batch build that overrides the one specified in the batch build project.

Source

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

The name of a certificate for this batch build that overrides the one specified in the batch build project.

Source

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

The name of a certificate for this batch build that overrides the one specified in the batch build project.

Source

pub fn cache_override(self, input: ProjectCache) -> Self

A ProjectCache object that specifies cache overrides.

Source

pub fn set_cache_override(self, input: Option<ProjectCache>) -> Self

A ProjectCache object that specifies cache overrides.

Source

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

A ProjectCache object that specifies cache overrides.

Source

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

The name of a service role for this batch build that overrides the one specified in the batch build project.

Source

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

The name of a service role for this batch build that overrides the one specified in the batch build project.

Source

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

The name of a service role for this batch build that overrides the one specified in the batch build project.

Source

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

Enable this flag to override privileged mode in the batch build project.

Source

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

Enable this flag to override privileged mode in the batch build project.

Source

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

Enable this flag to override privileged mode in the batch build project.

Source

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

Overrides the build timeout specified in the batch build project.

Source

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

Overrides the build timeout specified in the batch build project.

Source

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

Overrides the build timeout specified in the batch build project.

Source

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

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

Source

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

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

Source

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

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

Source

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

The Key Management Service customer master key (CMK) that overrides the one specified in the batch build project. The CMK key encrypts 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 set_encryption_key_override(self, input: Option<String>) -> Self

The Key Management Service customer master key (CMK) that overrides the one specified in the batch build project. The CMK key encrypts 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 get_encryption_key_override(&self) -> &Option<String>

The Key Management Service customer master key (CMK) that overrides the one specified in the batch build project. The CMK key encrypts 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 idempotency_token(self, input: impl Into<String>) -> Self

A unique, case sensitive identifier you provide to ensure the idempotency of the StartBuildBatch request. The token is included in the StartBuildBatch request and is valid for five minutes. If you repeat the StartBuildBatch request with the same token, but change a parameter, CodeBuild returns a parameter mismatch error.

Source

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

A unique, case sensitive identifier you provide to ensure the idempotency of the StartBuildBatch request. The token is included in the StartBuildBatch request and is valid for five minutes. If you repeat the StartBuildBatch request with the same token, but change a parameter, CodeBuild returns a parameter mismatch error.

Source

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

A unique, case sensitive identifier you provide to ensure the idempotency of the StartBuildBatch request. The token is included in the StartBuildBatch request and is valid for five minutes. If you repeat the StartBuildBatch request with the same token, but change a parameter, CodeBuild returns a parameter mismatch error.

Source

pub fn logs_config_override(self, input: LogsConfig) -> Self

A LogsConfig object that override the log settings defined in the batch build project.

Source

pub fn set_logs_config_override(self, input: Option<LogsConfig>) -> Self

A LogsConfig object that override the log settings defined in the batch build project.

Source

pub fn get_logs_config_override(&self) -> &Option<LogsConfig>

A LogsConfig object that override the log settings defined in the batch build project.

Source

pub fn registry_credential_override(self, input: RegistryCredential) -> Self

A RegistryCredential object that overrides credentials for access to a private registry.

Source

pub fn set_registry_credential_override( self, input: Option<RegistryCredential>, ) -> Self

A RegistryCredential object that overrides credentials for access to a private registry.

Source

pub fn get_registry_credential_override(&self) -> &Option<RegistryCredential>

A RegistryCredential object that overrides credentials for access to a private registry.

Source

pub fn image_pull_credentials_type_override( self, input: ImagePullCredentialsType, ) -> Self

The type of credentials CodeBuild uses to pull images in your batch build. There are two valid values:

CODEBUILD

Specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust CodeBuild's service principal.

SERVICE_ROLE

Specifies that CodeBuild uses your build project's service role.

When using a cross-account or private registry image, you must use SERVICE_ROLE credentials. When using an CodeBuild curated image, you must use CODEBUILD credentials.

Source

pub fn set_image_pull_credentials_type_override( self, input: Option<ImagePullCredentialsType>, ) -> Self

The type of credentials CodeBuild uses to pull images in your batch build. There are two valid values:

CODEBUILD

Specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust CodeBuild's service principal.

SERVICE_ROLE

Specifies that CodeBuild uses your build project's service role.

When using a cross-account or private registry image, you must use SERVICE_ROLE credentials. When using an CodeBuild curated image, you must use CODEBUILD credentials.

Source

pub fn get_image_pull_credentials_type_override( &self, ) -> &Option<ImagePullCredentialsType>

The type of credentials CodeBuild uses to pull images in your batch build. There are two valid values:

CODEBUILD

Specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust CodeBuild's service principal.

SERVICE_ROLE

Specifies that CodeBuild uses your build project's service role.

When using a cross-account or private registry image, you must use SERVICE_ROLE credentials. When using an CodeBuild curated image, you must use CODEBUILD credentials.

Source

pub fn build_batch_config_override(self, input: ProjectBuildBatchConfig) -> Self

A BuildBatchConfigOverride object that contains batch build configuration overrides.

Source

pub fn set_build_batch_config_override( self, input: Option<ProjectBuildBatchConfig>, ) -> Self

A BuildBatchConfigOverride object that contains batch build configuration overrides.

Source

pub fn get_build_batch_config_override( &self, ) -> &Option<ProjectBuildBatchConfig>

A BuildBatchConfigOverride object that contains batch build configuration overrides.

Source

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

Specifies if session debugging is enabled for this batch build. For more information, see Viewing a running build in Session Manager. Batch session debugging is not supported for matrix batch builds.

Source

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

Specifies if session debugging is enabled for this batch build. For more information, see Viewing a running build in Session Manager. Batch session debugging is not supported for matrix batch builds.

Source

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

Specifies if session debugging is enabled for this batch build. For more information, see Viewing a running build in Session Manager. Batch session debugging is not supported for matrix batch builds.

Trait Implementations§

Source§

impl Clone for StartBuildBatchFluentBuilder

Source§

fn clone(&self) -> StartBuildBatchFluentBuilder

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 StartBuildBatchFluentBuilder

Source§

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

Formats the value using the given formatter. Read more

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,