SnowflakeDestinationConfigurationBuilder

aws_sdk_firehose::types::builders

Struct SnowflakeDestinationConfigurationBuilder 

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

A builder for SnowflakeDestinationConfiguration.

Implementations§

Source§

impl SnowflakeDestinationConfigurationBuilder

Source

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

URL for accessing your Snowflake account. This URL must include your account identifier. Note that the protocol (https://) and port number are optional.

This field is required.
Source

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

URL for accessing your Snowflake account. This URL must include your account identifier. Note that the protocol (https://) and port number are optional.

Source

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

URL for accessing your Snowflake account. This URL must include your account identifier. Note that the protocol (https://) and port number are optional.

Source

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

The private key used to encrypt your Snowflake client. For information, see Using Key Pair Authentication & Key Rotation.

Source

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

The private key used to encrypt your Snowflake client. For information, see Using Key Pair Authentication & Key Rotation.

Source

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

The private key used to encrypt your Snowflake client. For information, see Using Key Pair Authentication & Key Rotation.

Source

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

Passphrase to decrypt the private key when the key is encrypted. For information, see Using Key Pair Authentication & Key Rotation.

Source

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

Passphrase to decrypt the private key when the key is encrypted. For information, see Using Key Pair Authentication & Key Rotation.

Source

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

Passphrase to decrypt the private key when the key is encrypted. For information, see Using Key Pair Authentication & Key Rotation.

Source

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

User login name for the Snowflake account.

Source

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

User login name for the Snowflake account.

Source

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

User login name for the Snowflake account.

Source

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

All data in Snowflake is maintained in databases.

This field is required.
Source

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

All data in Snowflake is maintained in databases.

Source

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

All data in Snowflake is maintained in databases.

Source

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

Each database consists of one or more schemas, which are logical groupings of database objects, such as tables and views

This field is required.
Source

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

Each database consists of one or more schemas, which are logical groupings of database objects, such as tables and views

Source

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

Each database consists of one or more schemas, which are logical groupings of database objects, such as tables and views

Source

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

All data in Snowflake is stored in database tables, logically structured as collections of columns and rows.

This field is required.
Source

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

All data in Snowflake is stored in database tables, logically structured as collections of columns and rows.

Source

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

All data in Snowflake is stored in database tables, logically structured as collections of columns and rows.

Source

pub fn snowflake_role_configuration( self, input: SnowflakeRoleConfiguration, ) -> Self

Optionally configure a Snowflake role. Otherwise the default user role will be used.

Source

pub fn set_snowflake_role_configuration( self, input: Option<SnowflakeRoleConfiguration>, ) -> Self

Optionally configure a Snowflake role. Otherwise the default user role will be used.

Source

pub fn get_snowflake_role_configuration( &self, ) -> &Option<SnowflakeRoleConfiguration>

Optionally configure a Snowflake role. Otherwise the default user role will be used.

Source

pub fn data_loading_option(self, input: SnowflakeDataLoadingOption) -> Self

Choose to load JSON keys mapped to table column names or choose to split the JSON payload where content is mapped to a record content column and source metadata is mapped to a record metadata column.

Source

pub fn set_data_loading_option( self, input: Option<SnowflakeDataLoadingOption>, ) -> Self

Choose to load JSON keys mapped to table column names or choose to split the JSON payload where content is mapped to a record content column and source metadata is mapped to a record metadata column.

Source

pub fn get_data_loading_option(&self) -> &Option<SnowflakeDataLoadingOption>

Choose to load JSON keys mapped to table column names or choose to split the JSON payload where content is mapped to a record content column and source metadata is mapped to a record metadata column.

Source

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

Specify a column name in the table, where the metadata information has to be loaded. When you enable this field, you will see the following column in the snowflake table, which differs based on the source type.

For Direct PUT as source

{ "firehoseDeliveryStreamName" : "streamname", "IngestionTime" : "timestamp" }

For Kinesis Data Stream as source

"kinesisStreamName" : "streamname", "kinesisShardId" : "Id", "kinesisPartitionKey" : "key", "kinesisSequenceNumber" : "1234", "subsequenceNumber" : "2334", "IngestionTime" : "timestamp" }

Source

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

Specify a column name in the table, where the metadata information has to be loaded. When you enable this field, you will see the following column in the snowflake table, which differs based on the source type.

For Direct PUT as source

{ "firehoseDeliveryStreamName" : "streamname", "IngestionTime" : "timestamp" }

For Kinesis Data Stream as source

"kinesisStreamName" : "streamname", "kinesisShardId" : "Id", "kinesisPartitionKey" : "key", "kinesisSequenceNumber" : "1234", "subsequenceNumber" : "2334", "IngestionTime" : "timestamp" }

Source

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

Specify a column name in the table, where the metadata information has to be loaded. When you enable this field, you will see the following column in the snowflake table, which differs based on the source type.

For Direct PUT as source

{ "firehoseDeliveryStreamName" : "streamname", "IngestionTime" : "timestamp" }

For Kinesis Data Stream as source

"kinesisStreamName" : "streamname", "kinesisShardId" : "Id", "kinesisPartitionKey" : "key", "kinesisSequenceNumber" : "1234", "subsequenceNumber" : "2334", "IngestionTime" : "timestamp" }

Source

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

The name of the record content column.

Source

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

The name of the record content column.

Source

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

The name of the record content column.

Source

pub fn snowflake_vpc_configuration( self, input: SnowflakeVpcConfiguration, ) -> Self

The VPCE ID for Firehose to privately connect with Snowflake. The ID format is com.amazonaws.vpce.\[region\].vpce-svc-<\[id\]>. For more information, see Amazon PrivateLink & Snowflake

Source

pub fn set_snowflake_vpc_configuration( self, input: Option<SnowflakeVpcConfiguration>, ) -> Self

The VPCE ID for Firehose to privately connect with Snowflake. The ID format is com.amazonaws.vpce.\[region\].vpce-svc-<\[id\]>. For more information, see Amazon PrivateLink & Snowflake

Source

pub fn get_snowflake_vpc_configuration( &self, ) -> &Option<SnowflakeVpcConfiguration>

The VPCE ID for Firehose to privately connect with Snowflake. The ID format is com.amazonaws.vpce.\[region\].vpce-svc-<\[id\]>. For more information, see Amazon PrivateLink & Snowflake

Source

pub fn cloud_watch_logging_options( self, input: CloudWatchLoggingOptions, ) -> Self

Describes the Amazon CloudWatch logging options for your Firehose stream.

Source

pub fn set_cloud_watch_logging_options( self, input: Option<CloudWatchLoggingOptions>, ) -> Self

Describes the Amazon CloudWatch logging options for your Firehose stream.

Source

pub fn get_cloud_watch_logging_options( &self, ) -> &Option<CloudWatchLoggingOptions>

Describes the Amazon CloudWatch logging options for your Firehose stream.

Source

pub fn processing_configuration(self, input: ProcessingConfiguration) -> Self

Describes a data processing configuration.

Source

pub fn set_processing_configuration( self, input: Option<ProcessingConfiguration>, ) -> Self

Describes a data processing configuration.

Source

pub fn get_processing_configuration(&self) -> &Option<ProcessingConfiguration>

Describes a data processing configuration.

Source

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

The Amazon Resource Name (ARN) of the Snowflake role

This field is required.
Source

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

The Amazon Resource Name (ARN) of the Snowflake role

Source

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

The Amazon Resource Name (ARN) of the Snowflake role

Source

pub fn retry_options(self, input: SnowflakeRetryOptions) -> Self

The time period where Firehose will retry sending data to the chosen HTTP endpoint.

Source

pub fn set_retry_options(self, input: Option<SnowflakeRetryOptions>) -> Self

The time period where Firehose will retry sending data to the chosen HTTP endpoint.

Source

pub fn get_retry_options(&self) -> &Option<SnowflakeRetryOptions>

The time period where Firehose will retry sending data to the chosen HTTP endpoint.

Source

pub fn s3_backup_mode(self, input: SnowflakeS3BackupMode) -> Self

Choose an S3 backup mode

Source

pub fn set_s3_backup_mode(self, input: Option<SnowflakeS3BackupMode>) -> Self

Choose an S3 backup mode

Source

pub fn get_s3_backup_mode(&self) -> &Option<SnowflakeS3BackupMode>

Choose an S3 backup mode

Source

pub fn s3_configuration(self, input: S3DestinationConfiguration) -> Self

Describes the configuration of a destination in Amazon S3.

This field is required.
Source

pub fn set_s3_configuration( self, input: Option<S3DestinationConfiguration>, ) -> Self

Describes the configuration of a destination in Amazon S3.

Source

pub fn get_s3_configuration(&self) -> &Option<S3DestinationConfiguration>

Describes the configuration of a destination in Amazon S3.

Source

pub fn secrets_manager_configuration( self, input: SecretsManagerConfiguration, ) -> Self

The configuration that defines how you access secrets for Snowflake.

Source

pub fn set_secrets_manager_configuration( self, input: Option<SecretsManagerConfiguration>, ) -> Self

The configuration that defines how you access secrets for Snowflake.

Source

pub fn get_secrets_manager_configuration( &self, ) -> &Option<SecretsManagerConfiguration>

The configuration that defines how you access secrets for Snowflake.

Source

pub fn buffering_hints(self, input: SnowflakeBufferingHints) -> Self

Describes the buffering to perform before delivering data to the Snowflake destination. If you do not specify any value, Firehose uses the default values.

Source

pub fn set_buffering_hints(self, input: Option<SnowflakeBufferingHints>) -> Self

Describes the buffering to perform before delivering data to the Snowflake destination. If you do not specify any value, Firehose uses the default values.

Source

pub fn get_buffering_hints(&self) -> &Option<SnowflakeBufferingHints>

Describes the buffering to perform before delivering data to the Snowflake destination. If you do not specify any value, Firehose uses the default values.

Source

pub fn build(self) -> Result<SnowflakeDestinationConfiguration, BuildError>

Consumes the builder and constructs a SnowflakeDestinationConfiguration. This method will fail if any of the following fields are not set:

Trait Implementations§

Source§

impl Clone for SnowflakeDestinationConfigurationBuilder

Source§

fn clone(&self) -> SnowflakeDestinationConfigurationBuilder

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 SnowflakeDestinationConfigurationBuilder

Source§

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

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

impl Default for SnowflakeDestinationConfigurationBuilder

Source§

fn default() -> SnowflakeDestinationConfigurationBuilder

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

impl PartialEq for SnowflakeDestinationConfigurationBuilder

Source§

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

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,