CustomerProfileAttributesBuilder

aws_sdk_qconnect::types::builders

Struct CustomerProfileAttributesBuilder 

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

A builder for CustomerProfileAttributes.

Implementations§

Source§

impl CustomerProfileAttributesBuilder

Source

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

The unique identifier of a customer profile.

Source

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

The unique identifier of a customer profile.

Source

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

The unique identifier of a customer profile.

Source

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

The ARN of a customer profile.

Source

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

The ARN of a customer profile.

Source

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

The ARN of a customer profile.

Source

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

The customer's first name.

Source

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

The customer's first name.

Source

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

The customer's first name.

Source

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

The customer's middle name.

Source

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

The customer's middle name.

Source

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

The customer's middle name.

Source

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

The customer's last name.

Source

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

The customer's last name.

Source

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

The customer's last name.

Source

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

A unique account number that you have given to the customer.

Source

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

A unique account number that you have given to the customer.

Source

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

A unique account number that you have given to the customer.

Source

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

The customer's email address, which has not been specified as a personal or business address.

Source

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

The customer's email address, which has not been specified as a personal or business address.

Source

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

The customer's email address, which has not been specified as a personal or business address.

Source

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

The customer's phone number, which has not been specified as a mobile, home, or business number.

Source

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

The customer's phone number, which has not been specified as a mobile, home, or business number.

Source

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

The customer's phone number, which has not been specified as a mobile, home, or business number.

Source

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

Any additional information relevant to the customer's profile.

Source

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

Any additional information relevant to the customer's profile.

Source

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

Any additional information relevant to the customer's profile.

Source

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

The customer's party type.

Source

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

The customer's party type.

Source

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

The customer's party type.

Source

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

The name of the customer's business.

Source

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

The name of the customer's business.

Source

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

The name of the customer's business.

Source

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

The customer's birth date.

Source

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

The customer's birth date.

Source

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

The customer's birth date.

Source

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

The customer's gender.

Source

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

The customer's gender.

Source

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

The customer's gender.

Source

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

The customer's mobile phone number.

Source

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

The customer's mobile phone number.

Source

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

The customer's mobile phone number.

Source

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

The customer's mobile phone number.

Source

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

The customer's mobile phone number.

Source

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

The customer's mobile phone number.

Source

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

The customer's business phone number.

Source

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

The customer's business phone number.

Source

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

The customer's business phone number.

Source

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

The customer's business email address.

Source

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

The customer's business email address.

Source

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

The customer's business email address.

Source

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

The first line of a customer address.

Source

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

The first line of a customer address.

Source

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

The first line of a customer address.

Source

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

The second line of a customer address.

Source

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

The second line of a customer address.

Source

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

The second line of a customer address.

Source

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

The third line of a customer address.

Source

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

The third line of a customer address.

Source

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

The third line of a customer address.

Source

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

The fourth line of a customer address.

Source

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

The fourth line of a customer address.

Source

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

The fourth line of a customer address.

Source

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

The city in which a customer lives.

Source

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

The city in which a customer lives.

Source

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

The city in which a customer lives.

Source

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

The county in which a customer lives.

Source

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

The county in which a customer lives.

Source

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

The county in which a customer lives.

Source

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

The country in which a customer lives.

Source

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

The country in which a customer lives.

Source

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

The country in which a customer lives.

Source

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

The postal code of a customer address.

Source

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

The postal code of a customer address.

Source

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

The postal code of a customer address.

Source

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

The province in which a customer lives.

Source

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

The province in which a customer lives.

Source

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

The province in which a customer lives.

Source

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

The state in which a customer lives.

Source

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

The state in which a customer lives.

Source

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

The state in which a customer lives.

Source

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

The first line of a customer’s shipping address.

Source

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

The first line of a customer’s shipping address.

Source

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

The first line of a customer’s shipping address.

Source

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

The second line of a customer’s shipping address.

Source

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

The second line of a customer’s shipping address.

Source

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

The second line of a customer’s shipping address.

Source

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

The third line of a customer’s shipping address.

Source

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

The third line of a customer’s shipping address.

Source

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

The third line of a customer’s shipping address.

Source

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

The fourth line of a customer’s shipping address.

Source

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

The fourth line of a customer’s shipping address.

Source

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

The fourth line of a customer’s shipping address.

Source

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

The city of a customer’s shipping address.

Source

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

The city of a customer’s shipping address.

Source

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

The city of a customer’s shipping address.

Source

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

The county of a customer’s shipping address.

Source

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

The county of a customer’s shipping address.

Source

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

The county of a customer’s shipping address.

Source

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

The country of a customer’s shipping address.

Source

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

The country of a customer’s shipping address.

Source

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

The country of a customer’s shipping address.

Source

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

The postal code of a customer’s shipping address.

Source

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

The postal code of a customer’s shipping address.

Source

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

The postal code of a customer’s shipping address.

Source

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

The province of a customer’s shipping address.

Source

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

The province of a customer’s shipping address.

Source

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

The province of a customer’s shipping address.

Source

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

The state of a customer’s shipping address.

Source

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

The state of a customer’s shipping address.

Source

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

The state of a customer’s shipping address.

Source

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

The first line of a customer’s mailing address.

Source

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

The first line of a customer’s mailing address.

Source

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

The first line of a customer’s mailing address.

Source

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

The second line of a customer’s mailing address.

Source

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

The second line of a customer’s mailing address.

Source

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

The second line of a customer’s mailing address.

Source

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

The third line of a customer’s mailing address.

Source

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

The third line of a customer’s mailing address.

Source

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

The third line of a customer’s mailing address.

Source

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

The fourth line of a customer’s mailing address.

Source

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

The fourth line of a customer’s mailing address.

Source

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

The fourth line of a customer’s mailing address.

Source

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

The city of a customer’s mailing address.

Source

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

The city of a customer’s mailing address.

Source

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

The city of a customer’s mailing address.

Source

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

The county of a customer’s mailing address.

Source

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

The county of a customer’s mailing address.

Source

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

The county of a customer’s mailing address.

Source

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

The country of a customer’s mailing address.

Source

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

The country of a customer’s mailing address.

Source

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

The country of a customer’s mailing address.

Source

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

The postal code of a customer’s mailing address.

Source

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

The postal code of a customer’s mailing address.

Source

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

The postal code of a customer’s mailing address.

Source

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

The province of a customer’s mailing address.

Source

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

The province of a customer’s mailing address.

Source

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

The province of a customer’s mailing address.

Source

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

The state of a customer’s mailing address.

Source

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

The state of a customer’s mailing address.

Source

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

The state of a customer’s mailing address.

Source

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

The first line of a customer’s billing address.

Source

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

The first line of a customer’s billing address.

Source

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

The first line of a customer’s billing address.

Source

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

The second line of a customer’s billing address.

Source

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

The second line of a customer’s billing address.

Source

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

The second line of a customer’s billing address.

Source

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

The third line of a customer’s billing address.

Source

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

The third line of a customer’s billing address.

Source

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

The third line of a customer’s billing address.

Source

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

The fourth line of a customer’s billing address.

Source

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

The fourth line of a customer’s billing address.

Source

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

The fourth line of a customer’s billing address.

Source

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

The city of a customer’s billing address.

Source

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

The city of a customer’s billing address.

Source

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

The city of a customer’s billing address.

Source

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

The county of a customer’s billing address.

Source

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

The county of a customer’s billing address.

Source

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

The county of a customer’s billing address.

Source

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

The country of a customer’s billing address.

Source

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

The country of a customer’s billing address.

Source

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

The country of a customer’s billing address.

Source

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

The postal code of a customer’s billing address.

Source

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

The postal code of a customer’s billing address.

Source

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

The postal code of a customer’s billing address.

Source

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

The province of a customer’s billing address.

Source

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

The province of a customer’s billing address.

Source

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

The province of a customer’s billing address.

Source

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

The state of a customer’s billing address.

Source

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

The state of a customer’s billing address.

Source

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

The state of a customer’s billing address.

Source

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

Adds a key-value pair to custom.

To override the contents of this collection use set_custom.

The custom attributes in customer profile attributes.

Source

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

The custom attributes in customer profile attributes.

Source

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

The custom attributes in customer profile attributes.

Source

pub fn build(self) -> CustomerProfileAttributes

Consumes the builder and constructs a CustomerProfileAttributes.

Trait Implementations§

Source§

impl Clone for CustomerProfileAttributesBuilder

Source§

fn clone(&self) -> CustomerProfileAttributesBuilder

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 CustomerProfileAttributesBuilder

Source§

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

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

impl Default for CustomerProfileAttributesBuilder

Source§

fn default() -> CustomerProfileAttributesBuilder

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

impl PartialEq for CustomerProfileAttributesBuilder

Source§

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

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,