aws_sdk_lambda::operation::get_event_source_mapping::builders

Struct GetEventSourceMappingOutputBuilder

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

A builder for GetEventSourceMappingOutput.

Implementations§

Source§

impl GetEventSourceMappingOutputBuilder

Source

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

The identifier of the event source mapping.

Source

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

The identifier of the event source mapping.

Source

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

The identifier of the event source mapping.

Source

pub fn starting_position(self, input: EventSourcePosition) -> Self

The position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB Stream event sources. AT_TIMESTAMP is supported only for Amazon Kinesis streams, Amazon DocumentDB, Amazon MSK, and self-managed Apache Kafka.

Source

pub fn set_starting_position(self, input: Option<EventSourcePosition>) -> Self

The position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB Stream event sources. AT_TIMESTAMP is supported only for Amazon Kinesis streams, Amazon DocumentDB, Amazon MSK, and self-managed Apache Kafka.

Source

pub fn get_starting_position(&self) -> &Option<EventSourcePosition>

The position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB Stream event sources. AT_TIMESTAMP is supported only for Amazon Kinesis streams, Amazon DocumentDB, Amazon MSK, and self-managed Apache Kafka.

Source

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

With StartingPosition set to AT_TIMESTAMP, the time from which to start reading. StartingPositionTimestamp cannot be in the future.

Source

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

With StartingPosition set to AT_TIMESTAMP, the time from which to start reading. StartingPositionTimestamp cannot be in the future.

Source

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

With StartingPosition set to AT_TIMESTAMP, the time from which to start reading. StartingPositionTimestamp cannot be in the future.

Source

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

The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function. Lambda passes all of the records in the batch to the function in a single call, up to the payload limit for synchronous invocation (6 MB).

Default value: Varies by service. For Amazon SQS, the default is 10. For all other services, the default is 100.

Related setting: When you set BatchSize to a value greater than 10, you must set MaximumBatchingWindowInSeconds to at least 1.

Source

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

The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function. Lambda passes all of the records in the batch to the function in a single call, up to the payload limit for synchronous invocation (6 MB).

Default value: Varies by service. For Amazon SQS, the default is 10. For all other services, the default is 100.

Related setting: When you set BatchSize to a value greater than 10, you must set MaximumBatchingWindowInSeconds to at least 1.

Source

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

The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function. Lambda passes all of the records in the batch to the function in a single call, up to the payload limit for synchronous invocation (6 MB).

Default value: Varies by service. For Amazon SQS, the default is 10. For all other services, the default is 100.

Related setting: When you set BatchSize to a value greater than 10, you must set MaximumBatchingWindowInSeconds to at least 1.

Source

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

The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function. You can configure MaximumBatchingWindowInSeconds to any value from 0 seconds to 300 seconds in increments of seconds.

For streams and Amazon SQS event sources, the default batching window is 0 seconds. For Amazon MSK, Self-managed Apache Kafka, Amazon MQ, and DocumentDB event sources, the default batching window is 500 ms. Note that because you can only change MaximumBatchingWindowInSeconds in increments of seconds, you cannot revert back to the 500 ms default batching window after you have changed it. To restore the default batching window, you must create a new event source mapping.

Related setting: For streams and Amazon SQS event sources, when you set BatchSize to a value greater than 10, you must set MaximumBatchingWindowInSeconds to at least 1.

Source

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

The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function. You can configure MaximumBatchingWindowInSeconds to any value from 0 seconds to 300 seconds in increments of seconds.

For streams and Amazon SQS event sources, the default batching window is 0 seconds. For Amazon MSK, Self-managed Apache Kafka, Amazon MQ, and DocumentDB event sources, the default batching window is 500 ms. Note that because you can only change MaximumBatchingWindowInSeconds in increments of seconds, you cannot revert back to the 500 ms default batching window after you have changed it. To restore the default batching window, you must create a new event source mapping.

Related setting: For streams and Amazon SQS event sources, when you set BatchSize to a value greater than 10, you must set MaximumBatchingWindowInSeconds to at least 1.

Source

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

The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function. You can configure MaximumBatchingWindowInSeconds to any value from 0 seconds to 300 seconds in increments of seconds.

For streams and Amazon SQS event sources, the default batching window is 0 seconds. For Amazon MSK, Self-managed Apache Kafka, Amazon MQ, and DocumentDB event sources, the default batching window is 500 ms. Note that because you can only change MaximumBatchingWindowInSeconds in increments of seconds, you cannot revert back to the 500 ms default batching window after you have changed it. To restore the default batching window, you must create a new event source mapping.

Related setting: For streams and Amazon SQS event sources, when you set BatchSize to a value greater than 10, you must set MaximumBatchingWindowInSeconds to at least 1.

Source

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

(Kinesis and DynamoDB Streams only) The number of batches to process concurrently from each shard. The default value is 1.

Source

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

(Kinesis and DynamoDB Streams only) The number of batches to process concurrently from each shard. The default value is 1.

Source

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

(Kinesis and DynamoDB Streams only) The number of batches to process concurrently from each shard. The default value is 1.

Source

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

The Amazon Resource Name (ARN) of the event source.

Source

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

The Amazon Resource Name (ARN) of the event source.

Source

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

The Amazon Resource Name (ARN) of the event source.

Source

pub fn filter_criteria(self, input: FilterCriteria) -> Self

An object that defines the filter criteria that determine whether Lambda should process an event. For more information, see Lambda event filtering.

If filter criteria is encrypted, this field shows up as null in the response of ListEventSourceMapping API calls. You can view this field in plaintext in the response of GetEventSourceMapping and DeleteEventSourceMapping calls if you have kms:Decrypt permissions for the correct KMS key.

Source

pub fn set_filter_criteria(self, input: Option<FilterCriteria>) -> Self

An object that defines the filter criteria that determine whether Lambda should process an event. For more information, see Lambda event filtering.

If filter criteria is encrypted, this field shows up as null in the response of ListEventSourceMapping API calls. You can view this field in plaintext in the response of GetEventSourceMapping and DeleteEventSourceMapping calls if you have kms:Decrypt permissions for the correct KMS key.

Source

pub fn get_filter_criteria(&self) -> &Option<FilterCriteria>

An object that defines the filter criteria that determine whether Lambda should process an event. For more information, see Lambda event filtering.

If filter criteria is encrypted, this field shows up as null in the response of ListEventSourceMapping API calls. You can view this field in plaintext in the response of GetEventSourceMapping and DeleteEventSourceMapping calls if you have kms:Decrypt permissions for the correct KMS key.

Source

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

The ARN of the Lambda function.

Source

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

The ARN of the Lambda function.

Source

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

The ARN of the Lambda function.

Source

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

The date that the event source mapping was last updated or that its state changed.

Source

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

The date that the event source mapping was last updated or that its state changed.

Source

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

The date that the event source mapping was last updated or that its state changed.

Source

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

The result of the last Lambda invocation of your function.

Source

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

The result of the last Lambda invocation of your function.

Source

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

The result of the last Lambda invocation of your function.

Source

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

The state of the event source mapping. It can be one of the following: Creating, Enabling, Enabled, Disabling, Disabled, Updating, or Deleting.

Source

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

The state of the event source mapping. It can be one of the following: Creating, Enabling, Enabled, Disabling, Disabled, Updating, or Deleting.

Source

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

The state of the event source mapping. It can be one of the following: Creating, Enabling, Enabled, Disabling, Disabled, Updating, or Deleting.

Source

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

Indicates whether a user or Lambda made the last change to the event source mapping.

Source

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

Indicates whether a user or Lambda made the last change to the event source mapping.

Source

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

Indicates whether a user or Lambda made the last change to the event source mapping.

Source

pub fn destination_config(self, input: DestinationConfig) -> Self

(Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka event sources only) A configuration object that specifies the destination of an event after Lambda processes it.

Source

pub fn set_destination_config(self, input: Option<DestinationConfig>) -> Self

(Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka event sources only) A configuration object that specifies the destination of an event after Lambda processes it.

Source

pub fn get_destination_config(&self) -> &Option<DestinationConfig>

(Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka event sources only) A configuration object that specifies the destination of an event after Lambda processes it.

Source

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

Appends an item to topics.

To override the contents of this collection use set_topics.

The name of the Kafka topic.

Source

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

The name of the Kafka topic.

Source

pub fn get_topics(&self) -> &Option<Vec<String>>

The name of the Kafka topic.

Source

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

Appends an item to queues.

To override the contents of this collection use set_queues.

(Amazon MQ) The name of the Amazon MQ broker destination queue to consume.

Source

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

(Amazon MQ) The name of the Amazon MQ broker destination queue to consume.

Source

pub fn get_queues(&self) -> &Option<Vec<String>>

(Amazon MQ) The name of the Amazon MQ broker destination queue to consume.

Source

pub fn source_access_configurations( self, input: SourceAccessConfiguration, ) -> Self

Appends an item to source_access_configurations.

To override the contents of this collection use set_source_access_configurations.

An array of the authentication protocol, VPC components, or virtual host to secure and define your event source.

Source

pub fn set_source_access_configurations( self, input: Option<Vec<SourceAccessConfiguration>>, ) -> Self

An array of the authentication protocol, VPC components, or virtual host to secure and define your event source.

Source

pub fn get_source_access_configurations( &self, ) -> &Option<Vec<SourceAccessConfiguration>>

An array of the authentication protocol, VPC components, or virtual host to secure and define your event source.

Source

pub fn self_managed_event_source(self, input: SelfManagedEventSource) -> Self

The self-managed Apache Kafka cluster for your event source.

Source

pub fn set_self_managed_event_source( self, input: Option<SelfManagedEventSource>, ) -> Self

The self-managed Apache Kafka cluster for your event source.

Source

pub fn get_self_managed_event_source(&self) -> &Option<SelfManagedEventSource>

The self-managed Apache Kafka cluster for your event source.

Source

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

(Kinesis and DynamoDB Streams only) Discard records older than the specified age. The default value is -1, which sets the maximum age to infinite. When the value is set to infinite, Lambda never discards old records.

The minimum valid value for maximum record age is 60s. Although values less than 60 and greater than -1 fall within the parameter's absolute range, they are not allowed

Source

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

(Kinesis and DynamoDB Streams only) Discard records older than the specified age. The default value is -1, which sets the maximum age to infinite. When the value is set to infinite, Lambda never discards old records.

The minimum valid value for maximum record age is 60s. Although values less than 60 and greater than -1 fall within the parameter's absolute range, they are not allowed

Source

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

(Kinesis and DynamoDB Streams only) Discard records older than the specified age. The default value is -1, which sets the maximum age to infinite. When the value is set to infinite, Lambda never discards old records.

The minimum valid value for maximum record age is 60s. Although values less than 60 and greater than -1 fall within the parameter's absolute range, they are not allowed

Source

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

(Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry. The default value is false.

Source

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

(Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry. The default value is false.

Source

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

(Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry. The default value is false.

Source

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

(Kinesis and DynamoDB Streams only) Discard records after the specified number of retries. The default value is -1, which sets the maximum number of retries to infinite. When MaximumRetryAttempts is infinite, Lambda retries failed records until the record expires in the event source.

Source

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

(Kinesis and DynamoDB Streams only) Discard records after the specified number of retries. The default value is -1, which sets the maximum number of retries to infinite. When MaximumRetryAttempts is infinite, Lambda retries failed records until the record expires in the event source.

Source

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

(Kinesis and DynamoDB Streams only) Discard records after the specified number of retries. The default value is -1, which sets the maximum number of retries to infinite. When MaximumRetryAttempts is infinite, Lambda retries failed records until the record expires in the event source.

Source

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

(Kinesis and DynamoDB Streams only) The duration in seconds of a processing window for DynamoDB and Kinesis Streams event sources. A value of 0 seconds indicates no tumbling window.

Source

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

(Kinesis and DynamoDB Streams only) The duration in seconds of a processing window for DynamoDB and Kinesis Streams event sources. A value of 0 seconds indicates no tumbling window.

Source

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

(Kinesis and DynamoDB Streams only) The duration in seconds of a processing window for DynamoDB and Kinesis Streams event sources. A value of 0 seconds indicates no tumbling window.

Source

pub fn function_response_types(self, input: FunctionResponseType) -> Self

Appends an item to function_response_types.

To override the contents of this collection use set_function_response_types.

(Kinesis, DynamoDB Streams, and Amazon SQS) A list of current response type enums applied to the event source mapping.

Source

pub fn set_function_response_types( self, input: Option<Vec<FunctionResponseType>>, ) -> Self

(Kinesis, DynamoDB Streams, and Amazon SQS) A list of current response type enums applied to the event source mapping.

Source

pub fn get_function_response_types(&self) -> &Option<Vec<FunctionResponseType>>

(Kinesis, DynamoDB Streams, and Amazon SQS) A list of current response type enums applied to the event source mapping.

Source

pub fn amazon_managed_kafka_event_source_config( self, input: AmazonManagedKafkaEventSourceConfig, ) -> Self

Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source.

Source

pub fn set_amazon_managed_kafka_event_source_config( self, input: Option<AmazonManagedKafkaEventSourceConfig>, ) -> Self

Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source.

Source

pub fn get_amazon_managed_kafka_event_source_config( &self, ) -> &Option<AmazonManagedKafkaEventSourceConfig>

Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source.

Source

pub fn self_managed_kafka_event_source_config( self, input: SelfManagedKafkaEventSourceConfig, ) -> Self

Specific configuration settings for a self-managed Apache Kafka event source.

Source

pub fn set_self_managed_kafka_event_source_config( self, input: Option<SelfManagedKafkaEventSourceConfig>, ) -> Self

Specific configuration settings for a self-managed Apache Kafka event source.

Source

pub fn get_self_managed_kafka_event_source_config( &self, ) -> &Option<SelfManagedKafkaEventSourceConfig>

Specific configuration settings for a self-managed Apache Kafka event source.

Source

pub fn scaling_config(self, input: ScalingConfig) -> Self

(Amazon SQS only) The scaling configuration for the event source. For more information, see Configuring maximum concurrency for Amazon SQS event sources.

Source

pub fn set_scaling_config(self, input: Option<ScalingConfig>) -> Self

(Amazon SQS only) The scaling configuration for the event source. For more information, see Configuring maximum concurrency for Amazon SQS event sources.

Source

pub fn get_scaling_config(&self) -> &Option<ScalingConfig>

(Amazon SQS only) The scaling configuration for the event source. For more information, see Configuring maximum concurrency for Amazon SQS event sources.

Source

pub fn document_db_event_source_config( self, input: DocumentDbEventSourceConfig, ) -> Self

Specific configuration settings for a DocumentDB event source.

Source

pub fn set_document_db_event_source_config( self, input: Option<DocumentDbEventSourceConfig>, ) -> Self

Specific configuration settings for a DocumentDB event source.

Source

pub fn get_document_db_event_source_config( &self, ) -> &Option<DocumentDbEventSourceConfig>

Specific configuration settings for a DocumentDB event source.

Source

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

The ARN of the Key Management Service (KMS) customer managed key that Lambda uses to encrypt your function's filter criteria.

Source

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

The ARN of the Key Management Service (KMS) customer managed key that Lambda uses to encrypt your function's filter criteria.

Source

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

The ARN of the Key Management Service (KMS) customer managed key that Lambda uses to encrypt your function's filter criteria.

Source

pub fn filter_criteria_error(self, input: FilterCriteriaError) -> Self

An object that contains details about an error related to filter criteria encryption.

Source

pub fn set_filter_criteria_error( self, input: Option<FilterCriteriaError>, ) -> Self

An object that contains details about an error related to filter criteria encryption.

Source

pub fn get_filter_criteria_error(&self) -> &Option<FilterCriteriaError>

An object that contains details about an error related to filter criteria encryption.

Source

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

The Amazon Resource Name (ARN) of the event source mapping.

Source

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

The Amazon Resource Name (ARN) of the event source mapping.

Source

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

The Amazon Resource Name (ARN) of the event source mapping.

Source

pub fn metrics_config(self, input: EventSourceMappingMetricsConfig) -> Self

The metrics configuration for your event source. For more information, see Event source mapping metrics.

Source

pub fn set_metrics_config( self, input: Option<EventSourceMappingMetricsConfig>, ) -> Self

The metrics configuration for your event source. For more information, see Event source mapping metrics.

Source

pub fn get_metrics_config(&self) -> &Option<EventSourceMappingMetricsConfig>

The metrics configuration for your event source. For more information, see Event source mapping metrics.

Source

pub fn provisioned_poller_config(self, input: ProvisionedPollerConfig) -> Self

(Amazon MSK and self-managed Apache Kafka only) The provisioned mode configuration for the event source. For more information, see provisioned mode.

Source

pub fn set_provisioned_poller_config( self, input: Option<ProvisionedPollerConfig>, ) -> Self

(Amazon MSK and self-managed Apache Kafka only) The provisioned mode configuration for the event source. For more information, see provisioned mode.

Source

pub fn get_provisioned_poller_config(&self) -> &Option<ProvisionedPollerConfig>

(Amazon MSK and self-managed Apache Kafka only) The provisioned mode configuration for the event source. For more information, see provisioned mode.

Source

pub fn build(self) -> GetEventSourceMappingOutput

Consumes the builder and constructs a GetEventSourceMappingOutput.

Trait Implementations§

Source§

impl Clone for GetEventSourceMappingOutputBuilder

Source§

fn clone(&self) -> GetEventSourceMappingOutputBuilder

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 GetEventSourceMappingOutputBuilder

Source§

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

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

impl Default for GetEventSourceMappingOutputBuilder

Source§

fn default() -> GetEventSourceMappingOutputBuilder

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

impl PartialEq for GetEventSourceMappingOutputBuilder

Source§

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

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,