CreateDeliveryStreamInputBuilder

aws_sdk_firehose::operation::create_delivery_stream::builders

Struct CreateDeliveryStreamInputBuilder 

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

A builder for CreateDeliveryStreamInput.

Implementations§

Source§

impl CreateDeliveryStreamInputBuilder

Source

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

The name of the Firehose stream. This name must be unique per Amazon Web Services account in the same Amazon Web Services Region. If the Firehose streams are in different accounts or different Regions, you can have multiple Firehose streams with the same name.

This field is required.
Source

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

The name of the Firehose stream. This name must be unique per Amazon Web Services account in the same Amazon Web Services Region. If the Firehose streams are in different accounts or different Regions, you can have multiple Firehose streams with the same name.

Source

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

The name of the Firehose stream. This name must be unique per Amazon Web Services account in the same Amazon Web Services Region. If the Firehose streams are in different accounts or different Regions, you can have multiple Firehose streams with the same name.

Source

pub fn delivery_stream_type(self, input: DeliveryStreamType) -> Self

The Firehose stream type. This parameter can be one of the following values:

  • DirectPut: Provider applications access the Firehose stream directly.

  • KinesisStreamAsSource: The Firehose stream uses a Kinesis data stream as a source.

Source

pub fn set_delivery_stream_type(self, input: Option<DeliveryStreamType>) -> Self

The Firehose stream type. This parameter can be one of the following values:

  • DirectPut: Provider applications access the Firehose stream directly.

  • KinesisStreamAsSource: The Firehose stream uses a Kinesis data stream as a source.

Source

pub fn get_delivery_stream_type(&self) -> &Option<DeliveryStreamType>

The Firehose stream type. This parameter can be one of the following values:

  • DirectPut: Provider applications access the Firehose stream directly.

  • KinesisStreamAsSource: The Firehose stream uses a Kinesis data stream as a source.

Source

pub fn direct_put_source_configuration( self, input: DirectPutSourceConfiguration, ) -> Self

The structure that configures parameters such as ThroughputHintInMBs for a stream configured with Direct PUT as a source.

Source

pub fn set_direct_put_source_configuration( self, input: Option<DirectPutSourceConfiguration>, ) -> Self

The structure that configures parameters such as ThroughputHintInMBs for a stream configured with Direct PUT as a source.

Source

pub fn get_direct_put_source_configuration( &self, ) -> &Option<DirectPutSourceConfiguration>

The structure that configures parameters such as ThroughputHintInMBs for a stream configured with Direct PUT as a source.

Source

pub fn kinesis_stream_source_configuration( self, input: KinesisStreamSourceConfiguration, ) -> Self

When a Kinesis data stream is used as the source for the Firehose stream, a KinesisStreamSourceConfiguration containing the Kinesis data stream Amazon Resource Name (ARN) and the role ARN for the source stream.

Source

pub fn set_kinesis_stream_source_configuration( self, input: Option<KinesisStreamSourceConfiguration>, ) -> Self

When a Kinesis data stream is used as the source for the Firehose stream, a KinesisStreamSourceConfiguration containing the Kinesis data stream Amazon Resource Name (ARN) and the role ARN for the source stream.

Source

pub fn get_kinesis_stream_source_configuration( &self, ) -> &Option<KinesisStreamSourceConfiguration>

When a Kinesis data stream is used as the source for the Firehose stream, a KinesisStreamSourceConfiguration containing the Kinesis data stream Amazon Resource Name (ARN) and the role ARN for the source stream.

Source

pub fn delivery_stream_encryption_configuration_input( self, input: DeliveryStreamEncryptionConfigurationInput, ) -> Self

Used to specify the type and Amazon Resource Name (ARN) of the KMS key needed for Server-Side Encryption (SSE).

Source

pub fn set_delivery_stream_encryption_configuration_input( self, input: Option<DeliveryStreamEncryptionConfigurationInput>, ) -> Self

Used to specify the type and Amazon Resource Name (ARN) of the KMS key needed for Server-Side Encryption (SSE).

Source

pub fn get_delivery_stream_encryption_configuration_input( &self, ) -> &Option<DeliveryStreamEncryptionConfigurationInput>

Used to specify the type and Amazon Resource Name (ARN) of the KMS key needed for Server-Side Encryption (SSE).

Source

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

👎Deprecated

\[Deprecated\] The destination in Amazon S3. You can specify only one destination.

Source

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

👎Deprecated

\[Deprecated\] The destination in Amazon S3. You can specify only one destination.

Source

pub fn get_s3_destination_configuration( &self, ) -> &Option<S3DestinationConfiguration>

👎Deprecated

\[Deprecated\] The destination in Amazon S3. You can specify only one destination.

Source

pub fn extended_s3_destination_configuration( self, input: ExtendedS3DestinationConfiguration, ) -> Self

The destination in Amazon S3. You can specify only one destination.

Source

pub fn set_extended_s3_destination_configuration( self, input: Option<ExtendedS3DestinationConfiguration>, ) -> Self

The destination in Amazon S3. You can specify only one destination.

Source

pub fn get_extended_s3_destination_configuration( &self, ) -> &Option<ExtendedS3DestinationConfiguration>

The destination in Amazon S3. You can specify only one destination.

Source

pub fn redshift_destination_configuration( self, input: RedshiftDestinationConfiguration, ) -> Self

The destination in Amazon Redshift. You can specify only one destination.

Source

pub fn set_redshift_destination_configuration( self, input: Option<RedshiftDestinationConfiguration>, ) -> Self

The destination in Amazon Redshift. You can specify only one destination.

Source

pub fn get_redshift_destination_configuration( &self, ) -> &Option<RedshiftDestinationConfiguration>

The destination in Amazon Redshift. You can specify only one destination.

Source

pub fn elasticsearch_destination_configuration( self, input: ElasticsearchDestinationConfiguration, ) -> Self

The destination in Amazon OpenSearch Service. You can specify only one destination.

Source

pub fn set_elasticsearch_destination_configuration( self, input: Option<ElasticsearchDestinationConfiguration>, ) -> Self

The destination in Amazon OpenSearch Service. You can specify only one destination.

Source

pub fn get_elasticsearch_destination_configuration( &self, ) -> &Option<ElasticsearchDestinationConfiguration>

The destination in Amazon OpenSearch Service. You can specify only one destination.

Source

pub fn amazonopensearchservice_destination_configuration( self, input: AmazonopensearchserviceDestinationConfiguration, ) -> Self

The destination in Amazon OpenSearch Service. You can specify only one destination.

Source

pub fn set_amazonopensearchservice_destination_configuration( self, input: Option<AmazonopensearchserviceDestinationConfiguration>, ) -> Self

The destination in Amazon OpenSearch Service. You can specify only one destination.

Source

pub fn get_amazonopensearchservice_destination_configuration( &self, ) -> &Option<AmazonopensearchserviceDestinationConfiguration>

The destination in Amazon OpenSearch Service. You can specify only one destination.

Source

pub fn splunk_destination_configuration( self, input: SplunkDestinationConfiguration, ) -> Self

The destination in Splunk. You can specify only one destination.

Source

pub fn set_splunk_destination_configuration( self, input: Option<SplunkDestinationConfiguration>, ) -> Self

The destination in Splunk. You can specify only one destination.

Source

pub fn get_splunk_destination_configuration( &self, ) -> &Option<SplunkDestinationConfiguration>

The destination in Splunk. You can specify only one destination.

Source

pub fn http_endpoint_destination_configuration( self, input: HttpEndpointDestinationConfiguration, ) -> Self

Enables configuring Kinesis Firehose to deliver data to any HTTP endpoint destination. You can specify only one destination.

Source

pub fn set_http_endpoint_destination_configuration( self, input: Option<HttpEndpointDestinationConfiguration>, ) -> Self

Enables configuring Kinesis Firehose to deliver data to any HTTP endpoint destination. You can specify only one destination.

Source

pub fn get_http_endpoint_destination_configuration( &self, ) -> &Option<HttpEndpointDestinationConfiguration>

Enables configuring Kinesis Firehose to deliver data to any HTTP endpoint destination. You can specify only one destination.

Source

pub fn tags(self, input: Tag) -> Self

Appends an item to tags.

To override the contents of this collection use set_tags.

A set of tags to assign to the Firehose stream. A tag is a key-value pair that you can define and assign to Amazon Web Services resources. Tags are metadata. For example, you can add friendly names and descriptions or other types of information that can help you distinguish the Firehose stream. For more information about tags, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.

You can specify up to 50 tags when creating a Firehose stream.

If you specify tags in the CreateDeliveryStream action, Amazon Data Firehose performs an additional authorization on the firehose:TagDeliveryStream action to verify if users have permissions to create tags. If you do not provide this permission, requests to create new Firehose streams with IAM resource tags will fail with an AccessDeniedException such as following.

AccessDeniedException

User: arn:aws:sts::x:assumed-role/x/x is not authorized to perform: firehose:TagDeliveryStream on resource: arn:aws:firehose:us-east-1:x:deliverystream/x with an explicit deny in an identity-based policy.

For an example IAM policy, see Tag example.

Source

pub fn set_tags(self, input: Option<Vec<Tag>>) -> Self

A set of tags to assign to the Firehose stream. A tag is a key-value pair that you can define and assign to Amazon Web Services resources. Tags are metadata. For example, you can add friendly names and descriptions or other types of information that can help you distinguish the Firehose stream. For more information about tags, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.

You can specify up to 50 tags when creating a Firehose stream.

If you specify tags in the CreateDeliveryStream action, Amazon Data Firehose performs an additional authorization on the firehose:TagDeliveryStream action to verify if users have permissions to create tags. If you do not provide this permission, requests to create new Firehose streams with IAM resource tags will fail with an AccessDeniedException such as following.

AccessDeniedException

User: arn:aws:sts::x:assumed-role/x/x is not authorized to perform: firehose:TagDeliveryStream on resource: arn:aws:firehose:us-east-1:x:deliverystream/x with an explicit deny in an identity-based policy.

For an example IAM policy, see Tag example.

Source

pub fn get_tags(&self) -> &Option<Vec<Tag>>

A set of tags to assign to the Firehose stream. A tag is a key-value pair that you can define and assign to Amazon Web Services resources. Tags are metadata. For example, you can add friendly names and descriptions or other types of information that can help you distinguish the Firehose stream. For more information about tags, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.

You can specify up to 50 tags when creating a Firehose stream.

If you specify tags in the CreateDeliveryStream action, Amazon Data Firehose performs an additional authorization on the firehose:TagDeliveryStream action to verify if users have permissions to create tags. If you do not provide this permission, requests to create new Firehose streams with IAM resource tags will fail with an AccessDeniedException such as following.

AccessDeniedException

User: arn:aws:sts::x:assumed-role/x/x is not authorized to perform: firehose:TagDeliveryStream on resource: arn:aws:firehose:us-east-1:x:deliverystream/x with an explicit deny in an identity-based policy.

For an example IAM policy, see Tag example.

Source

pub fn amazon_open_search_serverless_destination_configuration( self, input: AmazonOpenSearchServerlessDestinationConfiguration, ) -> Self

The destination in the Serverless offering for Amazon OpenSearch Service. You can specify only one destination.

Source

pub fn set_amazon_open_search_serverless_destination_configuration( self, input: Option<AmazonOpenSearchServerlessDestinationConfiguration>, ) -> Self

The destination in the Serverless offering for Amazon OpenSearch Service. You can specify only one destination.

Source

pub fn get_amazon_open_search_serverless_destination_configuration( &self, ) -> &Option<AmazonOpenSearchServerlessDestinationConfiguration>

The destination in the Serverless offering for Amazon OpenSearch Service. You can specify only one destination.

Source

pub fn msk_source_configuration(self, input: MskSourceConfiguration) -> Self

The configuration for the Amazon MSK cluster to be used as the source for a delivery stream.

Source

pub fn set_msk_source_configuration( self, input: Option<MskSourceConfiguration>, ) -> Self

The configuration for the Amazon MSK cluster to be used as the source for a delivery stream.

Source

pub fn get_msk_source_configuration(&self) -> &Option<MskSourceConfiguration>

The configuration for the Amazon MSK cluster to be used as the source for a delivery stream.

Source

pub fn snowflake_destination_configuration( self, input: SnowflakeDestinationConfiguration, ) -> Self

Configure Snowflake destination

Source

pub fn set_snowflake_destination_configuration( self, input: Option<SnowflakeDestinationConfiguration>, ) -> Self

Configure Snowflake destination

Source

pub fn get_snowflake_destination_configuration( &self, ) -> &Option<SnowflakeDestinationConfiguration>

Configure Snowflake destination

Source

pub fn iceberg_destination_configuration( self, input: IcebergDestinationConfiguration, ) -> Self

Configure Apache Iceberg Tables destination.

Source

pub fn set_iceberg_destination_configuration( self, input: Option<IcebergDestinationConfiguration>, ) -> Self

Configure Apache Iceberg Tables destination.

Source

pub fn get_iceberg_destination_configuration( &self, ) -> &Option<IcebergDestinationConfiguration>

Configure Apache Iceberg Tables destination.

Source

pub fn database_source_configuration( self, input: DatabaseSourceConfiguration, ) -> Self

The top level object for configuring streams with database as a source.

Amazon Data Firehose is in preview release and is subject to change.

Source

pub fn set_database_source_configuration( self, input: Option<DatabaseSourceConfiguration>, ) -> Self

The top level object for configuring streams with database as a source.

Amazon Data Firehose is in preview release and is subject to change.

Source

pub fn get_database_source_configuration( &self, ) -> &Option<DatabaseSourceConfiguration>

The top level object for configuring streams with database as a source.

Amazon Data Firehose is in preview release and is subject to change.

Source

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

Consumes the builder and constructs a CreateDeliveryStreamInput.

Source§

impl CreateDeliveryStreamInputBuilder

Source

pub async fn send_with( self, client: &Client, ) -> Result<CreateDeliveryStreamOutput, SdkError<CreateDeliveryStreamError, HttpResponse>>

Sends a request with this input using the given client.

Trait Implementations§

Source§

impl Clone for CreateDeliveryStreamInputBuilder

Source§

fn clone(&self) -> CreateDeliveryStreamInputBuilder

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 CreateDeliveryStreamInputBuilder

Source§

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

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

impl Default for CreateDeliveryStreamInputBuilder

Source§

fn default() -> CreateDeliveryStreamInputBuilder

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

impl PartialEq for CreateDeliveryStreamInputBuilder

Source§

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

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,