aws_sdk_devicefarm::types::builders

Struct RunBuilder

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

A builder for Run.

Implementations§

Source§

impl RunBuilder

Source

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

The run's ARN.

Source

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

The run's ARN.

Source

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

The run's ARN.

Source

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

The run's name.

Source

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

The run's name.

Source

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

The run's name.

Source

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

The run's type.

Must be one of the following values:

  • BUILTIN_FUZZ

  • APPIUM_JAVA_JUNIT

  • APPIUM_JAVA_TESTNG

  • APPIUM_PYTHON

  • APPIUM_NODE

  • APPIUM_RUBY

  • APPIUM_WEB_JAVA_JUNIT

  • APPIUM_WEB_JAVA_TESTNG

  • APPIUM_WEB_PYTHON

  • APPIUM_WEB_NODE

  • APPIUM_WEB_RUBY

  • INSTRUMENTATION

  • XCTEST

  • XCTEST_UI

Source

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

The run's type.

Must be one of the following values:

  • BUILTIN_FUZZ

  • APPIUM_JAVA_JUNIT

  • APPIUM_JAVA_TESTNG

  • APPIUM_PYTHON

  • APPIUM_NODE

  • APPIUM_RUBY

  • APPIUM_WEB_JAVA_JUNIT

  • APPIUM_WEB_JAVA_TESTNG

  • APPIUM_WEB_PYTHON

  • APPIUM_WEB_NODE

  • APPIUM_WEB_RUBY

  • INSTRUMENTATION

  • XCTEST

  • XCTEST_UI

Source

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

The run's type.

Must be one of the following values:

  • BUILTIN_FUZZ

  • APPIUM_JAVA_JUNIT

  • APPIUM_JAVA_TESTNG

  • APPIUM_PYTHON

  • APPIUM_NODE

  • APPIUM_RUBY

  • APPIUM_WEB_JAVA_JUNIT

  • APPIUM_WEB_JAVA_TESTNG

  • APPIUM_WEB_PYTHON

  • APPIUM_WEB_NODE

  • APPIUM_WEB_RUBY

  • INSTRUMENTATION

  • XCTEST

  • XCTEST_UI

Source

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

The run's platform.

Allowed values include:

  • ANDROID

  • IOS

Source

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

The run's platform.

Allowed values include:

  • ANDROID

  • IOS

Source

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

The run's platform.

Allowed values include:

  • ANDROID

  • IOS

Source

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

When the run was created.

Source

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

When the run was created.

Source

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

When the run was created.

Source

pub fn status(self, input: ExecutionStatus) -> Self

The run's status.

Allowed values include:

  • PENDING

  • PENDING_CONCURRENCY

  • PENDING_DEVICE

  • PROCESSING

  • SCHEDULING

  • PREPARING

  • RUNNING

  • COMPLETED

  • STOPPING

Source

pub fn set_status(self, input: Option<ExecutionStatus>) -> Self

The run's status.

Allowed values include:

  • PENDING

  • PENDING_CONCURRENCY

  • PENDING_DEVICE

  • PROCESSING

  • SCHEDULING

  • PREPARING

  • RUNNING

  • COMPLETED

  • STOPPING

Source

pub fn get_status(&self) -> &Option<ExecutionStatus>

The run's status.

Allowed values include:

  • PENDING

  • PENDING_CONCURRENCY

  • PENDING_DEVICE

  • PROCESSING

  • SCHEDULING

  • PREPARING

  • RUNNING

  • COMPLETED

  • STOPPING

Source

pub fn result(self, input: ExecutionResult) -> Self

The run's result.

Allowed values include:

  • PENDING

  • PASSED

  • WARNED

  • FAILED

  • SKIPPED

  • ERRORED

  • STOPPED

Source

pub fn set_result(self, input: Option<ExecutionResult>) -> Self

The run's result.

Allowed values include:

  • PENDING

  • PASSED

  • WARNED

  • FAILED

  • SKIPPED

  • ERRORED

  • STOPPED

Source

pub fn get_result(&self) -> &Option<ExecutionResult>

The run's result.

Allowed values include:

  • PENDING

  • PASSED

  • WARNED

  • FAILED

  • SKIPPED

  • ERRORED

  • STOPPED

Source

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

The run's start time.

Source

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

The run's start time.

Source

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

The run's start time.

Source

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

The run's stop time.

Source

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

The run's stop time.

Source

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

The run's stop time.

Source

pub fn counters(self, input: Counters) -> Self

The run's result counters.

Source

pub fn set_counters(self, input: Option<Counters>) -> Self

The run's result counters.

Source

pub fn get_counters(&self) -> &Option<Counters>

The run's result counters.

Source

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

A message about the run's result.

Source

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

A message about the run's result.

Source

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

A message about the run's result.

Source

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

The total number of jobs for the run.

Source

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

The total number of jobs for the run.

Source

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

The total number of jobs for the run.

Source

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

The total number of completed jobs.

Source

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

The total number of completed jobs.

Source

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

The total number of completed jobs.

Source

pub fn billing_method(self, input: BillingMethod) -> Self

Specifies the billing method for a test run: metered or unmetered. If the parameter is not specified, the default value is metered.

If you have unmetered device slots, you must set this to unmetered to use them. Otherwise, the run is counted toward metered device minutes.

Source

pub fn set_billing_method(self, input: Option<BillingMethod>) -> Self

Specifies the billing method for a test run: metered or unmetered. If the parameter is not specified, the default value is metered.

If you have unmetered device slots, you must set this to unmetered to use them. Otherwise, the run is counted toward metered device minutes.

Source

pub fn get_billing_method(&self) -> &Option<BillingMethod>

Specifies the billing method for a test run: metered or unmetered. If the parameter is not specified, the default value is metered.

If you have unmetered device slots, you must set this to unmetered to use them. Otherwise, the run is counted toward metered device minutes.

Source

pub fn device_minutes(self, input: DeviceMinutes) -> Self

Represents the total (metered or unmetered) minutes used by the test run.

Source

pub fn set_device_minutes(self, input: Option<DeviceMinutes>) -> Self

Represents the total (metered or unmetered) minutes used by the test run.

Source

pub fn get_device_minutes(&self) -> &Option<DeviceMinutes>

Represents the total (metered or unmetered) minutes used by the test run.

Source

pub fn network_profile(self, input: NetworkProfile) -> Self

The network profile being used for a test run.

Source

pub fn set_network_profile(self, input: Option<NetworkProfile>) -> Self

The network profile being used for a test run.

Source

pub fn get_network_profile(&self) -> &Option<NetworkProfile>

The network profile being used for a test run.

Source

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

Read-only URL for an object in an S3 bucket where you can get the parsing results of the test package. If the test package doesn't parse, the reason why it doesn't parse appears in the file that this URL points to.

Source

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

Read-only URL for an object in an S3 bucket where you can get the parsing results of the test package. If the test package doesn't parse, the reason why it doesn't parse appears in the file that this URL points to.

Source

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

Read-only URL for an object in an S3 bucket where you can get the parsing results of the test package. If the test package doesn't parse, the reason why it doesn't parse appears in the file that this URL points to.

Source

pub fn result_code(self, input: ExecutionResultCode) -> Self

Supporting field for the result field. Set only if result is SKIPPED. PARSING_FAILED if the result is skipped because of test package parsing failure.

Source

pub fn set_result_code(self, input: Option<ExecutionResultCode>) -> Self

Supporting field for the result field. Set only if result is SKIPPED. PARSING_FAILED if the result is skipped because of test package parsing failure.

Source

pub fn get_result_code(&self) -> &Option<ExecutionResultCode>

Supporting field for the result field. Set only if result is SKIPPED. PARSING_FAILED if the result is skipped because of test package parsing failure.

Source

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

For fuzz tests, this is a seed to use for randomizing the UI fuzz test. Using the same seed value between tests ensures identical event sequences.

Source

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

For fuzz tests, this is a seed to use for randomizing the UI fuzz test. Using the same seed value between tests ensures identical event sequences.

Source

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

For fuzz tests, this is a seed to use for randomizing the UI fuzz test. Using the same seed value between tests ensures identical event sequences.

Source

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

An app to upload or that has been uploaded.

Source

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

An app to upload or that has been uploaded.

Source

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

An app to upload or that has been uploaded.

Source

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

For fuzz tests, this is the number of events, between 1 and 10000, that the UI fuzz test should perform.

Source

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

For fuzz tests, this is the number of events, between 1 and 10000, that the UI fuzz test should perform.

Source

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

For fuzz tests, this is the number of events, between 1 and 10000, that the UI fuzz test should perform.

Source

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

The number of minutes the job executes before it times out.

Source

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

The number of minutes the job executes before it times out.

Source

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

The number of minutes the job executes before it times out.

Source

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

The ARN of the device pool for the run.

Source

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

The ARN of the device pool for the run.

Source

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

The ARN of the device pool for the run.

Source

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

Information about the locale that is used for the run.

Source

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

Information about the locale that is used for the run.

Source

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

Information about the locale that is used for the run.

Source

pub fn radios(self, input: Radios) -> Self

Information about the radio states for the run.

Source

pub fn set_radios(self, input: Option<Radios>) -> Self

Information about the radio states for the run.

Source

pub fn get_radios(&self) -> &Option<Radios>

Information about the radio states for the run.

Source

pub fn location(self, input: Location) -> Self

Information about the location that is used for the run.

Source

pub fn set_location(self, input: Option<Location>) -> Self

Information about the location that is used for the run.

Source

pub fn get_location(&self) -> &Option<Location>

Information about the location that is used for the run.

Source

pub fn customer_artifact_paths(self, input: CustomerArtifactPaths) -> Self

Output CustomerArtifactPaths object for the test run.

Source

pub fn set_customer_artifact_paths( self, input: Option<CustomerArtifactPaths>, ) -> Self

Output CustomerArtifactPaths object for the test run.

Source

pub fn get_customer_artifact_paths(&self) -> &Option<CustomerArtifactPaths>

Output CustomerArtifactPaths object for the test run.

Source

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

The Device Farm console URL for the recording of the run.

Source

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

The Device Farm console URL for the recording of the run.

Source

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

The Device Farm console URL for the recording of the run.

Source

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

When set to true, for private devices, Device Farm does not sign your app again. For public devices, Device Farm always signs your apps again.

For more information about how Device Farm re-signs your apps, see Do you modify my app? in the AWS Device Farm FAQs.

Source

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

When set to true, for private devices, Device Farm does not sign your app again. For public devices, Device Farm always signs your apps again.

For more information about how Device Farm re-signs your apps, see Do you modify my app? in the AWS Device Farm FAQs.

Source

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

When set to true, for private devices, Device Farm does not sign your app again. For public devices, Device Farm always signs your apps again.

For more information about how Device Farm re-signs your apps, see Do you modify my app? in the AWS Device Farm FAQs.

Source

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

The ARN of the YAML-formatted test specification for the run.

Source

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

The ARN of the YAML-formatted test specification for the run.

Source

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

The ARN of the YAML-formatted test specification for the run.

Source

pub fn device_selection_result(self, input: DeviceSelectionResult) -> Self

The results of a device filter used to select the devices for a test run.

Source

pub fn set_device_selection_result( self, input: Option<DeviceSelectionResult>, ) -> Self

The results of a device filter used to select the devices for a test run.

Source

pub fn get_device_selection_result(&self) -> &Option<DeviceSelectionResult>

The results of a device filter used to select the devices for a test run.

Source

pub fn vpc_config(self, input: VpcConfig) -> Self

The VPC security groups and subnets that are attached to a project.

Source

pub fn set_vpc_config(self, input: Option<VpcConfig>) -> Self

The VPC security groups and subnets that are attached to a project.

Source

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

The VPC security groups and subnets that are attached to a project.

Source

pub fn build(self) -> Run

Consumes the builder and constructs a Run.

Trait Implementations§

Source§

impl Clone for RunBuilder

Source§

fn clone(&self) -> RunBuilder

Returns a copy 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 RunBuilder

Source§

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

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

impl Default for RunBuilder

Source§

fn default() -> RunBuilder

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

impl PartialEq for RunBuilder

Source§

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

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, dst: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. 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,

Source§

impl<T> MaybeSendSync for T