aws_sdk_connect::types::builders

Struct ContactBuilder

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

A builder for Contact.

Implementations§

Source§

impl ContactBuilder

Source

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

The Amazon Resource Name (ARN) for the contact.

Source

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

The Amazon Resource Name (ARN) for the contact.

Source

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

The Amazon Resource Name (ARN) for the contact.

Source

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

The identifier for the contact.

Source

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

The identifier for the contact.

Source

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

The identifier for the contact.

Source

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

If this contact is related to other contacts, this is the ID of the initial contact.

Source

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

If this contact is related to other contacts, this is the ID of the initial contact.

Source

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

If this contact is related to other contacts, this is the ID of the initial contact.

Source

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

If this contact is not the first contact, this is the ID of the previous contact.

Source

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

If this contact is not the first contact, this is the ID of the previous contact.

Source

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

If this contact is not the first contact, this is the ID of the previous contact.

Source

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

This is the root contactId which is used as a unique identifier for all subsequent contacts in a contact tree.

Source

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

This is the root contactId which is used as a unique identifier for all subsequent contacts in a contact tree.

Source

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

This is the root contactId which is used as a unique identifier for all subsequent contacts in a contact tree.

Source

pub fn initiation_method(self, input: ContactInitiationMethod) -> Self

Indicates how the contact was initiated.

Source

pub fn set_initiation_method( self, input: Option<ContactInitiationMethod>, ) -> Self

Indicates how the contact was initiated.

Source

pub fn get_initiation_method(&self) -> &Option<ContactInitiationMethod>

Indicates how the contact was initiated.

Source

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

The name of the contact.

Source

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

The name of the contact.

Source

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

The name of the contact.

Source

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

The description of the contact.

Source

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

The description of the contact.

Source

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

The description of the contact.

Source

pub fn channel(self, input: Channel) -> Self

How the contact reached your contact center.

Source

pub fn set_channel(self, input: Option<Channel>) -> Self

How the contact reached your contact center.

Source

pub fn get_channel(&self) -> &Option<Channel>

How the contact reached your contact center.

Source

pub fn queue_info(self, input: QueueInfo) -> Self

If this contact was queued, this contains information about the queue.

Source

pub fn set_queue_info(self, input: Option<QueueInfo>) -> Self

If this contact was queued, this contains information about the queue.

Source

pub fn get_queue_info(&self) -> &Option<QueueInfo>

If this contact was queued, this contains information about the queue.

Source

pub fn agent_info(self, input: AgentInfo) -> Self

Information about the agent who accepted the contact.

Source

pub fn set_agent_info(self, input: Option<AgentInfo>) -> Self

Information about the agent who accepted the contact.

Source

pub fn get_agent_info(&self) -> &Option<AgentInfo>

Information about the agent who accepted the contact.

Source

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

The date and time this contact was initiated, in UTC time. For INBOUND, this is when the contact arrived. For OUTBOUND, this is when the agent began dialing. For CALLBACK, this is when the callback contact was created. For TRANSFER and QUEUE_TRANSFER, this is when the transfer was initiated. For API, this is when the request arrived. For EXTERNAL_OUTBOUND, this is when the agent started dialing the external participant. For MONITOR, this is when the supervisor started listening to a contact.

Source

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

The date and time this contact was initiated, in UTC time. For INBOUND, this is when the contact arrived. For OUTBOUND, this is when the agent began dialing. For CALLBACK, this is when the callback contact was created. For TRANSFER and QUEUE_TRANSFER, this is when the transfer was initiated. For API, this is when the request arrived. For EXTERNAL_OUTBOUND, this is when the agent started dialing the external participant. For MONITOR, this is when the supervisor started listening to a contact.

Source

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

The date and time this contact was initiated, in UTC time. For INBOUND, this is when the contact arrived. For OUTBOUND, this is when the agent began dialing. For CALLBACK, this is when the callback contact was created. For TRANSFER and QUEUE_TRANSFER, this is when the transfer was initiated. For API, this is when the request arrived. For EXTERNAL_OUTBOUND, this is when the agent started dialing the external participant. For MONITOR, this is when the supervisor started listening to a contact.

Source

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

The timestamp when the customer endpoint disconnected from Amazon Connect.

Source

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

The timestamp when the customer endpoint disconnected from Amazon Connect.

Source

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

The timestamp when the customer endpoint disconnected from Amazon Connect.

Source

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

The timestamp when contact was last updated.

Source

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

The timestamp when contact was last updated.

Source

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

The timestamp when contact was last updated.

Source

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

The timestamp when the contact was last paused.

Source

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

The timestamp when the contact was last paused.

Source

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

The timestamp when the contact was last paused.

Source

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

The timestamp when the contact was last resumed.

Source

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

The timestamp when the contact was last resumed.

Source

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

The timestamp when the contact was last resumed.

Source

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

Total pause count for a contact.

Source

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

Total pause count for a contact.

Source

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

Total pause count for a contact.

Source

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

Total pause duration for a contact in seconds.

Source

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

Total pause duration for a contact in seconds.

Source

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

Total pause duration for a contact in seconds.

Source

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

The timestamp, in Unix epoch time format, at which to start running the inbound flow.

Source

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

The timestamp, in Unix epoch time format, at which to start running the inbound flow.

Source

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

The timestamp, in Unix epoch time format, at which to start running the inbound flow.

Source

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

The contactId that is related to this contact.

The contactId that is related to this contact.

The contactId that is related to this contact.

Source

pub fn wisdom_info(self, input: WisdomInfo) -> Self

Information about Amazon Connect Wisdom.

Source

pub fn set_wisdom_info(self, input: Option<WisdomInfo>) -> Self

Information about Amazon Connect Wisdom.

Source

pub fn get_wisdom_info(&self) -> &Option<WisdomInfo>

Information about Amazon Connect Wisdom.

Source

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

The customer's identification number. For example, the CustomerId may be a customer number from your CRM. You can create a Lambda function to pull the unique customer ID of the caller from your CRM system. If you enable Amazon Connect Voice ID capability, this attribute is populated with the CustomerSpeakerId of the caller.

Source

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

The customer's identification number. For example, the CustomerId may be a customer number from your CRM. You can create a Lambda function to pull the unique customer ID of the caller from your CRM system. If you enable Amazon Connect Voice ID capability, this attribute is populated with the CustomerSpeakerId of the caller.

Source

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

The customer's identification number. For example, the CustomerId may be a customer number from your CRM. You can create a Lambda function to pull the unique customer ID of the caller from your CRM system. If you enable Amazon Connect Voice ID capability, this attribute is populated with the CustomerSpeakerId of the caller.

Source

pub fn customer_endpoint(self, input: EndpointInfo) -> Self

The customer or external third party participant endpoint.

Source

pub fn set_customer_endpoint(self, input: Option<EndpointInfo>) -> Self

The customer or external third party participant endpoint.

Source

pub fn get_customer_endpoint(&self) -> &Option<EndpointInfo>

The customer or external third party participant endpoint.

Source

pub fn system_endpoint(self, input: EndpointInfo) -> Self

The system endpoint. For INBOUND, this is the phone number or email address that the customer dialed. For OUTBOUND and EXTERNAL_OUTBOUND, this is the outbound caller ID number assigned to the outbound queue that is used to dial the customer. For callback, this shows up as Softphone for calls handled by agents with softphone.

Source

pub fn set_system_endpoint(self, input: Option<EndpointInfo>) -> Self

The system endpoint. For INBOUND, this is the phone number or email address that the customer dialed. For OUTBOUND and EXTERNAL_OUTBOUND, this is the outbound caller ID number assigned to the outbound queue that is used to dial the customer. For callback, this shows up as Softphone for calls handled by agents with softphone.

Source

pub fn get_system_endpoint(&self) -> &Option<EndpointInfo>

The system endpoint. For INBOUND, this is the phone number or email address that the customer dialed. For OUTBOUND and EXTERNAL_OUTBOUND, this is the outbound caller ID number assigned to the outbound queue that is used to dial the customer. For callback, this shows up as Softphone for calls handled by agents with softphone.

Source

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

An integer that represents the queue time adjust to be applied to the contact, in seconds (longer / larger queue time are routed preferentially). Cannot be specified if the QueuePriority is specified. Must be statically defined and a valid integer value.

Source

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

An integer that represents the queue time adjust to be applied to the contact, in seconds (longer / larger queue time are routed preferentially). Cannot be specified if the QueuePriority is specified. Must be statically defined and a valid integer value.

Source

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

An integer that represents the queue time adjust to be applied to the contact, in seconds (longer / larger queue time are routed preferentially). Cannot be specified if the QueuePriority is specified. Must be statically defined and a valid integer value.

Source

pub fn queue_priority(self, input: i64) -> Self

An integer that represents the queue priority to be applied to the contact (lower priorities are routed preferentially). Cannot be specified if the QueueTimeAdjustmentSeconds is specified. Must be statically defined, must be larger than zero, and a valid integer value. Default Value is 5.

Source

pub fn set_queue_priority(self, input: Option<i64>) -> Self

An integer that represents the queue priority to be applied to the contact (lower priorities are routed preferentially). Cannot be specified if the QueueTimeAdjustmentSeconds is specified. Must be statically defined, must be larger than zero, and a valid integer value. Default Value is 5.

Source

pub fn get_queue_priority(&self) -> &Option<i64>

An integer that represents the queue priority to be applied to the contact (lower priorities are routed preferentially). Cannot be specified if the QueueTimeAdjustmentSeconds is specified. Must be statically defined, must be larger than zero, and a valid integer value. Default Value is 5.

Source

pub fn tags(self, k: impl Into<String>, v: impl Into<String>) -> Self

Adds a key-value pair to tags.

To override the contents of this collection use set_tags.

Tags associated with the contact. This contains both Amazon Web Services generated and user-defined tags.

Source

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

Tags associated with the contact. This contains both Amazon Web Services generated and user-defined tags.

Source

pub fn get_tags(&self) -> &Option<HashMap<String, String>>

Tags associated with the contact. This contains both Amazon Web Services generated and user-defined tags.

Source

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

The timestamp when customer endpoint connected to Amazon Connect.

Source

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

The timestamp when customer endpoint connected to Amazon Connect.

Source

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

The timestamp when customer endpoint connected to Amazon Connect.

Source

pub fn routing_criteria(self, input: RoutingCriteria) -> Self

Latest routing criteria on the contact.

Source

pub fn set_routing_criteria(self, input: Option<RoutingCriteria>) -> Self

Latest routing criteria on the contact.

Source

pub fn get_routing_criteria(&self) -> &Option<RoutingCriteria>

Latest routing criteria on the contact.

Source

pub fn customer(self, input: Customer) -> Self

Information about the Customer on the contact.

Source

pub fn set_customer(self, input: Option<Customer>) -> Self

Information about the Customer on the contact.

Source

pub fn get_customer(&self) -> &Option<Customer>

Information about the Customer on the contact.

Source

pub fn campaign(self, input: Campaign) -> Self

Information associated with a campaign.

Source

pub fn set_campaign(self, input: Option<Campaign>) -> Self

Information associated with a campaign.

Source

pub fn get_campaign(&self) -> &Option<Campaign>

Information associated with a campaign.

Source

pub fn answering_machine_detection_status( self, input: AnsweringMachineDetectionStatus, ) -> Self

Indicates how an outbound campaign call is actually disposed if the contact is connected to Amazon Connect.

Source

pub fn set_answering_machine_detection_status( self, input: Option<AnsweringMachineDetectionStatus>, ) -> Self

Indicates how an outbound campaign call is actually disposed if the contact is connected to Amazon Connect.

Source

pub fn get_answering_machine_detection_status( &self, ) -> &Option<AnsweringMachineDetectionStatus>

Indicates how an outbound campaign call is actually disposed if the contact is connected to Amazon Connect.

Source

pub fn customer_voice_activity(self, input: CustomerVoiceActivity) -> Self

Information about customer’s voice activity.

Source

pub fn set_customer_voice_activity( self, input: Option<CustomerVoiceActivity>, ) -> Self

Information about customer’s voice activity.

Source

pub fn get_customer_voice_activity(&self) -> &Option<CustomerVoiceActivity>

Information about customer’s voice activity.

Source

pub fn quality_metrics(self, input: QualityMetrics) -> Self

Information about the quality of the participant's media connection.

Source

pub fn set_quality_metrics(self, input: Option<QualityMetrics>) -> Self

Information about the quality of the participant's media connection.

Source

pub fn get_quality_metrics(&self) -> &Option<QualityMetrics>

Information about the quality of the participant's media connection.

Source

pub fn disconnect_details(self, input: DisconnectDetails) -> Self

Information about the call disconnect experience.

Source

pub fn set_disconnect_details(self, input: Option<DisconnectDetails>) -> Self

Information about the call disconnect experience.

Source

pub fn get_disconnect_details(&self) -> &Option<DisconnectDetails>

Information about the call disconnect experience.

Source

pub fn additional_email_recipients( self, input: AdditionalEmailRecipients, ) -> Self

List of additional email addresses for an email contact.

Source

pub fn set_additional_email_recipients( self, input: Option<AdditionalEmailRecipients>, ) -> Self

List of additional email addresses for an email contact.

Source

pub fn get_additional_email_recipients( &self, ) -> &Option<AdditionalEmailRecipients>

List of additional email addresses for an email contact.

Source

pub fn segment_attributes( self, k: impl Into<String>, v: SegmentAttributeValue, ) -> Self

Adds a key-value pair to segment_attributes.

To override the contents of this collection use set_segment_attributes.

A set of system defined key-value pairs stored on individual contact segments using an attribute map. The attributes are standard Amazon Connect attributes and can be accessed in flows. Attribute keys can include only alphanumeric, -, and _ characters. This field can be used to show channel subtype. For example, connect:Guide or connect:SMS.

Source

pub fn set_segment_attributes( self, input: Option<HashMap<String, SegmentAttributeValue>>, ) -> Self

A set of system defined key-value pairs stored on individual contact segments using an attribute map. The attributes are standard Amazon Connect attributes and can be accessed in flows. Attribute keys can include only alphanumeric, -, and _ characters. This field can be used to show channel subtype. For example, connect:Guide or connect:SMS.

Source

pub fn get_segment_attributes( &self, ) -> &Option<HashMap<String, SegmentAttributeValue>>

A set of system defined key-value pairs stored on individual contact segments using an attribute map. The attributes are standard Amazon Connect attributes and can be accessed in flows. Attribute keys can include only alphanumeric, -, and _ characters. This field can be used to show channel subtype. For example, connect:Guide or connect:SMS.

Source

pub fn build(self) -> Contact

Consumes the builder and constructs a Contact.

Trait Implementations§

Source§

impl Clone for ContactBuilder

Source§

fn clone(&self) -> ContactBuilder

Returns a copy of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for ContactBuilder

Source§

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

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

impl Default for ContactBuilder

Source§

fn default() -> ContactBuilder

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

impl PartialEq for ContactBuilder

Source§

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

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

Source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
Source§

impl<T> Paint for T
where T: ?Sized,

Source§

fn fg(&self, value: Color) -> Painted<&T>

Returns a styled value derived from self with the foreground set to value.

This method should be used rarely. Instead, prefer to use color-specific builder methods like red() and green(), which have the same functionality but are pithier.

§Example

Set foreground color to white using fg():

use yansi::{Paint, Color};

painted.fg(Color::White);

Set foreground color to white using white().

use yansi::Paint;

painted.white();
Source§

fn primary(&self) -> Painted<&T>

Returns self with the fg() set to Color::Primary.

§Example
println!("{}", value.primary());
Source§

fn fixed(&self, color: u8) -> Painted<&T>

Returns self with the fg() set to Color::Fixed.

§Example
println!("{}", value.fixed(color));
Source§

fn rgb(&self, r: u8, g: u8, b: u8) -> Painted<&T>

Returns self with the fg() set to Color::Rgb.

§Example
println!("{}", value.rgb(r, g, b));
Source§

fn black(&self) -> Painted<&T>

Returns self with the fg() set to Color::Black.

§Example
println!("{}", value.black());
Source§

fn red(&self) -> Painted<&T>

Returns self with the fg() set to Color::Red.

§Example
println!("{}", value.red());
Source§

fn green(&self) -> Painted<&T>

Returns self with the fg() set to Color::Green.

§Example
println!("{}", value.green());
Source§

fn yellow(&self) -> Painted<&T>

Returns self with the fg() set to Color::Yellow.

§Example
println!("{}", value.yellow());
Source§

fn blue(&self) -> Painted<&T>

Returns self with the fg() set to Color::Blue.

§Example
println!("{}", value.blue());
Source§

fn magenta(&self) -> Painted<&T>

Returns self with the fg() set to Color::Magenta.

§Example
println!("{}", value.magenta());
Source§

fn cyan(&self) -> Painted<&T>

Returns self with the fg() set to Color::Cyan.

§Example
println!("{}", value.cyan());
Source§

fn white(&self) -> Painted<&T>

Returns self with the fg() set to Color::White.

§Example
println!("{}", value.white());
Source§

fn bright_black(&self) -> Painted<&T>

Returns self with the fg() set to Color::BrightBlack.

§Example
println!("{}", value.bright_black());
Source§

fn bright_red(&self) -> Painted<&T>

Returns self with the fg() set to Color::BrightRed.

§Example
println!("{}", value.bright_red());
Source§

fn bright_green(&self) -> Painted<&T>

Returns self with the fg() set to Color::BrightGreen.

§Example
println!("{}", value.bright_green());
Source§

fn bright_yellow(&self) -> Painted<&T>

Returns self with the fg() set to Color::BrightYellow.

§Example
println!("{}", value.bright_yellow());
Source§

fn bright_blue(&self) -> Painted<&T>

Returns self with the fg() set to Color::BrightBlue.

§Example
println!("{}", value.bright_blue());
Source§

fn bright_magenta(&self) -> Painted<&T>

Returns self with the fg() set to Color::BrightMagenta.

§Example
println!("{}", value.bright_magenta());
Source§

fn bright_cyan(&self) -> Painted<&T>

Returns self with the fg() set to Color::BrightCyan.

§Example
println!("{}", value.bright_cyan());
Source§

fn bright_white(&self) -> Painted<&T>

Returns self with the fg() set to Color::BrightWhite.

§Example
println!("{}", value.bright_white());
Source§

fn bg(&self, value: Color) -> Painted<&T>

Returns a styled value derived from self with the background set to value.

This method should be used rarely. Instead, prefer to use color-specific builder methods like on_red() and on_green(), which have the same functionality but are pithier.

§Example

Set background color to red using fg():

use yansi::{Paint, Color};

painted.bg(Color::Red);

Set background color to red using on_red().

use yansi::Paint;

painted.on_red();
Source§

fn on_primary(&self) -> Painted<&T>

Returns self with the bg() set to Color::Primary.

§Example
println!("{}", value.on_primary());
Source§

fn on_fixed(&self, color: u8) -> Painted<&T>

Returns self with the bg() set to Color::Fixed.

§Example
println!("{}", value.on_fixed(color));
Source§

fn on_rgb(&self, r: u8, g: u8, b: u8) -> Painted<&T>

Returns self with the bg() set to Color::Rgb.

§Example
println!("{}", value.on_rgb(r, g, b));
Source§

fn on_black(&self) -> Painted<&T>

Returns self with the bg() set to Color::Black.

§Example
println!("{}", value.on_black());
Source§

fn on_red(&self) -> Painted<&T>

Returns self with the bg() set to Color::Red.

§Example
println!("{}", value.on_red());
Source§

fn on_green(&self) -> Painted<&T>

Returns self with the bg() set to Color::Green.

§Example
println!("{}", value.on_green());
Source§

fn on_yellow(&self) -> Painted<&T>

Returns self with the bg() set to Color::Yellow.

§Example
println!("{}", value.on_yellow());
Source§

fn on_blue(&self) -> Painted<&T>

Returns self with the bg() set to Color::Blue.

§Example
println!("{}", value.on_blue());
Source§

fn on_magenta(&self) -> Painted<&T>

Returns self with the bg() set to Color::Magenta.

§Example
println!("{}", value.on_magenta());
Source§

fn on_cyan(&self) -> Painted<&T>

Returns self with the bg() set to Color::Cyan.

§Example
println!("{}", value.on_cyan());
Source§

fn on_white(&self) -> Painted<&T>

Returns self with the bg() set to Color::White.

§Example
println!("{}", value.on_white());
Source§

fn on_bright_black(&self) -> Painted<&T>

Returns self with the bg() set to Color::BrightBlack.

§Example
println!("{}", value.on_bright_black());
Source§

fn on_bright_red(&self) -> Painted<&T>

Returns self with the bg() set to Color::BrightRed.

§Example
println!("{}", value.on_bright_red());
Source§

fn on_bright_green(&self) -> Painted<&T>

Returns self with the bg() set to Color::BrightGreen.

§Example
println!("{}", value.on_bright_green());
Source§

fn on_bright_yellow(&self) -> Painted<&T>

Returns self with the bg() set to Color::BrightYellow.

§Example
println!("{}", value.on_bright_yellow());
Source§

fn on_bright_blue(&self) -> Painted<&T>

Returns self with the bg() set to Color::BrightBlue.

§Example
println!("{}", value.on_bright_blue());
Source§

fn on_bright_magenta(&self) -> Painted<&T>

Returns self with the bg() set to Color::BrightMagenta.

§Example
println!("{}", value.on_bright_magenta());
Source§

fn on_bright_cyan(&self) -> Painted<&T>

Returns self with the bg() set to Color::BrightCyan.

§Example
println!("{}", value.on_bright_cyan());
Source§

fn on_bright_white(&self) -> Painted<&T>

Returns self with the bg() set to Color::BrightWhite.

§Example
println!("{}", value.on_bright_white());
Source§

fn attr(&self, value: Attribute) -> Painted<&T>

Enables the styling Attribute value.

This method should be used rarely. Instead, prefer to use attribute-specific builder methods like bold() and underline(), which have the same functionality but are pithier.

§Example

Make text bold using attr():

use yansi::{Paint, Attribute};

painted.attr(Attribute::Bold);

Make text bold using using bold().

use yansi::Paint;

painted.bold();
Source§

fn bold(&self) -> Painted<&T>

Returns self with the attr() set to Attribute::Bold.

§Example
println!("{}", value.bold());
Source§

fn dim(&self) -> Painted<&T>

Returns self with the attr() set to Attribute::Dim.

§Example
println!("{}", value.dim());
Source§

fn italic(&self) -> Painted<&T>

Returns self with the attr() set to Attribute::Italic.

§Example
println!("{}", value.italic());
Source§

fn underline(&self) -> Painted<&T>

Returns self with the attr() set to Attribute::Underline.

§Example
println!("{}", value.underline());

Returns self with the attr() set to Attribute::Blink.

§Example
println!("{}", value.blink());

Returns self with the attr() set to Attribute::RapidBlink.

§Example
println!("{}", value.rapid_blink());
Source§

fn invert(&self) -> Painted<&T>

Returns self with the attr() set to Attribute::Invert.

§Example
println!("{}", value.invert());
Source§

fn conceal(&self) -> Painted<&T>

Returns self with the attr() set to Attribute::Conceal.

§Example
println!("{}", value.conceal());
Source§

fn strike(&self) -> Painted<&T>

Returns self with the attr() set to Attribute::Strike.

§Example
println!("{}", value.strike());
Source§

fn quirk(&self, value: Quirk) -> Painted<&T>

Enables the yansi Quirk value.

This method should be used rarely. Instead, prefer to use quirk-specific builder methods like mask() and wrap(), which have the same functionality but are pithier.

§Example

Enable wrapping using .quirk():

use yansi::{Paint, Quirk};

painted.quirk(Quirk::Wrap);

Enable wrapping using wrap().

use yansi::Paint;

painted.wrap();
Source§

fn mask(&self) -> Painted<&T>

Returns self with the quirk() set to Quirk::Mask.

§Example
println!("{}", value.mask());
Source§

fn wrap(&self) -> Painted<&T>

Returns self with the quirk() set to Quirk::Wrap.

§Example
println!("{}", value.wrap());
Source§

fn linger(&self) -> Painted<&T>

Returns self with the quirk() set to Quirk::Linger.

§Example
println!("{}", value.linger());
Source§

fn clear(&self) -> Painted<&T>

👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear(). The clear() method will be removed in a future release.

Returns self with the quirk() set to Quirk::Clear.

§Example
println!("{}", value.clear());
Source§

fn resetting(&self) -> Painted<&T>

Returns self with the quirk() set to Quirk::Resetting.

§Example
println!("{}", value.resetting());
Source§

fn bright(&self) -> Painted<&T>

Returns self with the quirk() set to Quirk::Bright.

§Example
println!("{}", value.bright());
Source§

fn on_bright(&self) -> Painted<&T>

Returns self with the quirk() set to Quirk::OnBright.

§Example
println!("{}", value.on_bright());
Source§

fn whenever(&self, value: Condition) -> Painted<&T>

Conditionally enable styling based on whether the Condition value applies. Replaces any previous condition.

See the crate level docs for more details.

§Example

Enable styling painted only when both stdout and stderr are TTYs:

use yansi::{Paint, Condition};

painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);
Source§

fn new(self) -> Painted<Self>
where Self: Sized,

Create a new Painted with a default Style. Read more
Source§

fn paint<S>(&self, style: S) -> Painted<&Self>
where S: Into<Style>,

Apply a style wholesale to self. Any previous style is replaced. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> MaybeSendSync for T