pub struct CreateCampaignFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to CreateCampaign
.
Creates an orchestration of data collection rules. The Amazon Web Services IoT FleetWise Edge Agent software running in vehicles uses campaigns to decide how to collect and transfer data to the cloud. You create campaigns in the cloud. After you or your team approve campaigns, Amazon Web Services IoT FleetWise automatically deploys them to vehicles.
For more information, see Collect and transfer data with campaigns in the Amazon Web Services IoT FleetWise Developer Guide.
Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the Amazon Web Services IoT FleetWise Developer Guide.
Implementations§
Source§impl CreateCampaignFluentBuilder
impl CreateCampaignFluentBuilder
Sourcepub fn as_input(&self) -> &CreateCampaignInputBuilder
pub fn as_input(&self) -> &CreateCampaignInputBuilder
Access the CreateCampaign as a reference.
Sourcepub async fn send(
self,
) -> Result<CreateCampaignOutput, SdkError<CreateCampaignError, HttpResponse>>
pub async fn send( self, ) -> Result<CreateCampaignOutput, SdkError<CreateCampaignError, 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.
Sourcepub fn customize(
self,
) -> CustomizableOperation<CreateCampaignOutput, CreateCampaignError, Self>
pub fn customize( self, ) -> CustomizableOperation<CreateCampaignOutput, CreateCampaignError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn description(self, input: impl Into<String>) -> Self
pub fn description(self, input: impl Into<String>) -> Self
An optional description of the campaign to help identify its purpose.
Sourcepub fn set_description(self, input: Option<String>) -> Self
pub fn set_description(self, input: Option<String>) -> Self
An optional description of the campaign to help identify its purpose.
Sourcepub fn get_description(&self) -> &Option<String>
pub fn get_description(&self) -> &Option<String>
An optional description of the campaign to help identify its purpose.
Sourcepub fn signal_catalog_arn(self, input: impl Into<String>) -> Self
pub fn signal_catalog_arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) of the signal catalog to associate with the campaign.
Sourcepub fn set_signal_catalog_arn(self, input: Option<String>) -> Self
pub fn set_signal_catalog_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) of the signal catalog to associate with the campaign.
Sourcepub fn get_signal_catalog_arn(&self) -> &Option<String>
pub fn get_signal_catalog_arn(&self) -> &Option<String>
The Amazon Resource Name (ARN) of the signal catalog to associate with the campaign.
Sourcepub fn target_arn(self, input: impl Into<String>) -> Self
pub fn target_arn(self, input: impl Into<String>) -> Self
The ARN of the vehicle or fleet to deploy a campaign to.
Sourcepub fn set_target_arn(self, input: Option<String>) -> Self
pub fn set_target_arn(self, input: Option<String>) -> Self
The ARN of the vehicle or fleet to deploy a campaign to.
Sourcepub fn get_target_arn(&self) -> &Option<String>
pub fn get_target_arn(&self) -> &Option<String>
The ARN of the vehicle or fleet to deploy a campaign to.
Sourcepub fn start_time(self, input: DateTime) -> Self
pub fn start_time(self, input: DateTime) -> Self
The time, in milliseconds, to deliver a campaign after it was approved. If it's not specified, 0
is used.
Default: 0
Sourcepub fn set_start_time(self, input: Option<DateTime>) -> Self
pub fn set_start_time(self, input: Option<DateTime>) -> Self
The time, in milliseconds, to deliver a campaign after it was approved. If it's not specified, 0
is used.
Default: 0
Sourcepub fn get_start_time(&self) -> &Option<DateTime>
pub fn get_start_time(&self) -> &Option<DateTime>
The time, in milliseconds, to deliver a campaign after it was approved. If it's not specified, 0
is used.
Default: 0
Sourcepub fn expiry_time(self, input: DateTime) -> Self
pub fn expiry_time(self, input: DateTime) -> Self
The time the campaign expires, in seconds since epoch (January 1, 1970 at midnight UTC time). Vehicle data isn't collected after the campaign expires.
Default: 253402214400 (December 31, 9999, 00:00:00 UTC)
Sourcepub fn set_expiry_time(self, input: Option<DateTime>) -> Self
pub fn set_expiry_time(self, input: Option<DateTime>) -> Self
The time the campaign expires, in seconds since epoch (January 1, 1970 at midnight UTC time). Vehicle data isn't collected after the campaign expires.
Default: 253402214400 (December 31, 9999, 00:00:00 UTC)
Sourcepub fn get_expiry_time(&self) -> &Option<DateTime>
pub fn get_expiry_time(&self) -> &Option<DateTime>
The time the campaign expires, in seconds since epoch (January 1, 1970 at midnight UTC time). Vehicle data isn't collected after the campaign expires.
Default: 253402214400 (December 31, 9999, 00:00:00 UTC)
Sourcepub fn post_trigger_collection_duration(self, input: i64) -> Self
pub fn post_trigger_collection_duration(self, input: i64) -> Self
How long (in milliseconds) to collect raw data after a triggering event initiates the collection. If it's not specified, 0
is used.
Default: 0
Sourcepub fn set_post_trigger_collection_duration(self, input: Option<i64>) -> Self
pub fn set_post_trigger_collection_duration(self, input: Option<i64>) -> Self
How long (in milliseconds) to collect raw data after a triggering event initiates the collection. If it's not specified, 0
is used.
Default: 0
Sourcepub fn get_post_trigger_collection_duration(&self) -> &Option<i64>
pub fn get_post_trigger_collection_duration(&self) -> &Option<i64>
How long (in milliseconds) to collect raw data after a triggering event initiates the collection. If it's not specified, 0
is used.
Default: 0
Sourcepub fn diagnostics_mode(self, input: DiagnosticsMode) -> Self
pub fn diagnostics_mode(self, input: DiagnosticsMode) -> Self
Option for a vehicle to send diagnostic trouble codes to Amazon Web Services IoT FleetWise. If you want to send diagnostic trouble codes, use SEND_ACTIVE_DTCS
. If it's not specified, OFF
is used.
Default: OFF
Sourcepub fn set_diagnostics_mode(self, input: Option<DiagnosticsMode>) -> Self
pub fn set_diagnostics_mode(self, input: Option<DiagnosticsMode>) -> Self
Option for a vehicle to send diagnostic trouble codes to Amazon Web Services IoT FleetWise. If you want to send diagnostic trouble codes, use SEND_ACTIVE_DTCS
. If it's not specified, OFF
is used.
Default: OFF
Sourcepub fn get_diagnostics_mode(&self) -> &Option<DiagnosticsMode>
pub fn get_diagnostics_mode(&self) -> &Option<DiagnosticsMode>
Option for a vehicle to send diagnostic trouble codes to Amazon Web Services IoT FleetWise. If you want to send diagnostic trouble codes, use SEND_ACTIVE_DTCS
. If it's not specified, OFF
is used.
Default: OFF
Sourcepub fn spooling_mode(self, input: SpoolingMode) -> Self
pub fn spooling_mode(self, input: SpoolingMode) -> Self
Determines whether to store collected data after a vehicle lost a connection with the cloud. After a connection is re-established, the data is automatically forwarded to Amazon Web Services IoT FleetWise. If you want to store collected data when a vehicle loses connection with the cloud, use TO_DISK
. If it's not specified, OFF
is used.
Default: OFF
Sourcepub fn set_spooling_mode(self, input: Option<SpoolingMode>) -> Self
pub fn set_spooling_mode(self, input: Option<SpoolingMode>) -> Self
Determines whether to store collected data after a vehicle lost a connection with the cloud. After a connection is re-established, the data is automatically forwarded to Amazon Web Services IoT FleetWise. If you want to store collected data when a vehicle loses connection with the cloud, use TO_DISK
. If it's not specified, OFF
is used.
Default: OFF
Sourcepub fn get_spooling_mode(&self) -> &Option<SpoolingMode>
pub fn get_spooling_mode(&self) -> &Option<SpoolingMode>
Determines whether to store collected data after a vehicle lost a connection with the cloud. After a connection is re-established, the data is automatically forwarded to Amazon Web Services IoT FleetWise. If you want to store collected data when a vehicle loses connection with the cloud, use TO_DISK
. If it's not specified, OFF
is used.
Default: OFF
Sourcepub fn compression(self, input: Compression) -> Self
pub fn compression(self, input: Compression) -> Self
Determines whether to compress signals before transmitting data to Amazon Web Services IoT FleetWise. If you don't want to compress the signals, use OFF
. If it's not specified, SNAPPY
is used.
Default: SNAPPY
Sourcepub fn set_compression(self, input: Option<Compression>) -> Self
pub fn set_compression(self, input: Option<Compression>) -> Self
Determines whether to compress signals before transmitting data to Amazon Web Services IoT FleetWise. If you don't want to compress the signals, use OFF
. If it's not specified, SNAPPY
is used.
Default: SNAPPY
Sourcepub fn get_compression(&self) -> &Option<Compression>
pub fn get_compression(&self) -> &Option<Compression>
Determines whether to compress signals before transmitting data to Amazon Web Services IoT FleetWise. If you don't want to compress the signals, use OFF
. If it's not specified, SNAPPY
is used.
Default: SNAPPY
Sourcepub fn priority(self, input: i32) -> Self
👎Deprecated: priority is no longer used or needed as input
pub fn priority(self, input: i32) -> Self
A number indicating the priority of one campaign over another campaign for a certain vehicle or fleet. A campaign with the lowest value is deployed to vehicles before any other campaigns. If it's not specified, 0
is used.
Default: 0
Sourcepub fn set_priority(self, input: Option<i32>) -> Self
👎Deprecated: priority is no longer used or needed as input
pub fn set_priority(self, input: Option<i32>) -> Self
A number indicating the priority of one campaign over another campaign for a certain vehicle or fleet. A campaign with the lowest value is deployed to vehicles before any other campaigns. If it's not specified, 0
is used.
Default: 0
Sourcepub fn get_priority(&self) -> &Option<i32>
👎Deprecated: priority is no longer used or needed as input
pub fn get_priority(&self) -> &Option<i32>
A number indicating the priority of one campaign over another campaign for a certain vehicle or fleet. A campaign with the lowest value is deployed to vehicles before any other campaigns. If it's not specified, 0
is used.
Default: 0
Sourcepub fn signals_to_collect(self, input: SignalInformation) -> Self
pub fn signals_to_collect(self, input: SignalInformation) -> Self
Appends an item to signalsToCollect
.
To override the contents of this collection use set_signals_to_collect
.
A list of information about signals to collect.
If you upload a signal as a condition in a data partition for a campaign, then those same signals must be included in signalsToCollect
.
Sourcepub fn set_signals_to_collect(
self,
input: Option<Vec<SignalInformation>>,
) -> Self
pub fn set_signals_to_collect( self, input: Option<Vec<SignalInformation>>, ) -> Self
A list of information about signals to collect.
If you upload a signal as a condition in a data partition for a campaign, then those same signals must be included in signalsToCollect
.
Sourcepub fn get_signals_to_collect(&self) -> &Option<Vec<SignalInformation>>
pub fn get_signals_to_collect(&self) -> &Option<Vec<SignalInformation>>
A list of information about signals to collect.
If you upload a signal as a condition in a data partition for a campaign, then those same signals must be included in signalsToCollect
.
Sourcepub fn collection_scheme(self, input: CollectionScheme) -> Self
pub fn collection_scheme(self, input: CollectionScheme) -> Self
The data collection scheme associated with the campaign. You can specify a scheme that collects data based on time or an event.
Sourcepub fn set_collection_scheme(self, input: Option<CollectionScheme>) -> Self
pub fn set_collection_scheme(self, input: Option<CollectionScheme>) -> Self
The data collection scheme associated with the campaign. You can specify a scheme that collects data based on time or an event.
Sourcepub fn get_collection_scheme(&self) -> &Option<CollectionScheme>
pub fn get_collection_scheme(&self) -> &Option<CollectionScheme>
The data collection scheme associated with the campaign. You can specify a scheme that collects data based on time or an event.
Sourcepub fn data_extra_dimensions(self, input: impl Into<String>) -> Self
pub fn data_extra_dimensions(self, input: impl Into<String>) -> Self
Appends an item to dataExtraDimensions
.
To override the contents of this collection use set_data_extra_dimensions
.
A list of vehicle attributes to associate with a campaign.
Enrich the data with specified vehicle attributes. For example, add make
and model
to the campaign, and Amazon Web Services IoT FleetWise will associate the data with those attributes as dimensions in Amazon Timestream. You can then query the data against make
and model
.
Default: An empty array
Sourcepub fn set_data_extra_dimensions(self, input: Option<Vec<String>>) -> Self
pub fn set_data_extra_dimensions(self, input: Option<Vec<String>>) -> Self
A list of vehicle attributes to associate with a campaign.
Enrich the data with specified vehicle attributes. For example, add make
and model
to the campaign, and Amazon Web Services IoT FleetWise will associate the data with those attributes as dimensions in Amazon Timestream. You can then query the data against make
and model
.
Default: An empty array
Sourcepub fn get_data_extra_dimensions(&self) -> &Option<Vec<String>>
pub fn get_data_extra_dimensions(&self) -> &Option<Vec<String>>
A list of vehicle attributes to associate with a campaign.
Enrich the data with specified vehicle attributes. For example, add make
and model
to the campaign, and Amazon Web Services IoT FleetWise will associate the data with those attributes as dimensions in Amazon Timestream. You can then query the data against make
and model
.
Default: An empty array
Appends an item to tags
.
To override the contents of this collection use set_tags
.
Metadata that can be used to manage the campaign.
Metadata that can be used to manage the campaign.
Metadata that can be used to manage the campaign.
Sourcepub fn data_destination_configs(self, input: DataDestinationConfig) -> Self
pub fn data_destination_configs(self, input: DataDestinationConfig) -> Self
Appends an item to dataDestinationConfigs
.
To override the contents of this collection use set_data_destination_configs
.
The destination where the campaign sends data. You can send data to an MQTT topic, or store it in Amazon S3 or Amazon Timestream.
MQTT is the publish/subscribe messaging protocol used by Amazon Web Services IoT to communicate with your devices.
Amazon S3 optimizes the cost of data storage and provides additional mechanisms to use vehicle data, such as data lakes, centralized data storage, data processing pipelines, and analytics. Amazon Web Services IoT FleetWise supports at-least-once file delivery to S3. Your vehicle data is stored on multiple Amazon Web Services IoT FleetWise servers for redundancy and high availability.
You can use Amazon Timestream to access and analyze time series data, and Timestream to query vehicle data so that you can identify trends and patterns.
Sourcepub fn set_data_destination_configs(
self,
input: Option<Vec<DataDestinationConfig>>,
) -> Self
pub fn set_data_destination_configs( self, input: Option<Vec<DataDestinationConfig>>, ) -> Self
The destination where the campaign sends data. You can send data to an MQTT topic, or store it in Amazon S3 or Amazon Timestream.
MQTT is the publish/subscribe messaging protocol used by Amazon Web Services IoT to communicate with your devices.
Amazon S3 optimizes the cost of data storage and provides additional mechanisms to use vehicle data, such as data lakes, centralized data storage, data processing pipelines, and analytics. Amazon Web Services IoT FleetWise supports at-least-once file delivery to S3. Your vehicle data is stored on multiple Amazon Web Services IoT FleetWise servers for redundancy and high availability.
You can use Amazon Timestream to access and analyze time series data, and Timestream to query vehicle data so that you can identify trends and patterns.
Sourcepub fn get_data_destination_configs(
&self,
) -> &Option<Vec<DataDestinationConfig>>
pub fn get_data_destination_configs( &self, ) -> &Option<Vec<DataDestinationConfig>>
The destination where the campaign sends data. You can send data to an MQTT topic, or store it in Amazon S3 or Amazon Timestream.
MQTT is the publish/subscribe messaging protocol used by Amazon Web Services IoT to communicate with your devices.
Amazon S3 optimizes the cost of data storage and provides additional mechanisms to use vehicle data, such as data lakes, centralized data storage, data processing pipelines, and analytics. Amazon Web Services IoT FleetWise supports at-least-once file delivery to S3. Your vehicle data is stored on multiple Amazon Web Services IoT FleetWise servers for redundancy and high availability.
You can use Amazon Timestream to access and analyze time series data, and Timestream to query vehicle data so that you can identify trends and patterns.
Sourcepub fn data_partitions(self, input: DataPartition) -> Self
pub fn data_partitions(self, input: DataPartition) -> Self
Appends an item to dataPartitions
.
To override the contents of this collection use set_data_partitions
.
The data partitions associated with the signals collected from the vehicle.
Sourcepub fn set_data_partitions(self, input: Option<Vec<DataPartition>>) -> Self
pub fn set_data_partitions(self, input: Option<Vec<DataPartition>>) -> Self
The data partitions associated with the signals collected from the vehicle.
Sourcepub fn get_data_partitions(&self) -> &Option<Vec<DataPartition>>
pub fn get_data_partitions(&self) -> &Option<Vec<DataPartition>>
The data partitions associated with the signals collected from the vehicle.
Sourcepub fn signals_to_fetch(self, input: SignalFetchInformation) -> Self
pub fn signals_to_fetch(self, input: SignalFetchInformation) -> Self
Appends an item to signalsToFetch
.
To override the contents of this collection use set_signals_to_fetch
.
A list of information about signals to fetch.
Sourcepub fn set_signals_to_fetch(
self,
input: Option<Vec<SignalFetchInformation>>,
) -> Self
pub fn set_signals_to_fetch( self, input: Option<Vec<SignalFetchInformation>>, ) -> Self
A list of information about signals to fetch.
Sourcepub fn get_signals_to_fetch(&self) -> &Option<Vec<SignalFetchInformation>>
pub fn get_signals_to_fetch(&self) -> &Option<Vec<SignalFetchInformation>>
A list of information about signals to fetch.
Trait Implementations§
Source§impl Clone for CreateCampaignFluentBuilder
impl Clone for CreateCampaignFluentBuilder
Source§fn clone(&self) -> CreateCampaignFluentBuilder
fn clone(&self) -> CreateCampaignFluentBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl Freeze for CreateCampaignFluentBuilder
impl !RefUnwindSafe for CreateCampaignFluentBuilder
impl Send for CreateCampaignFluentBuilder
impl Sync for CreateCampaignFluentBuilder
impl Unpin for CreateCampaignFluentBuilder
impl !UnwindSafe for CreateCampaignFluentBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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 moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
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 bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
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>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
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 rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
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 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.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
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);