#[non_exhaustive]pub struct ProfileBuilder { /* private fields */ }
Expand description
A builder for Profile
.
Implementations§
Source§impl ProfileBuilder
impl ProfileBuilder
Sourcepub fn profile_id(self, input: impl Into<String>) -> Self
pub fn profile_id(self, input: impl Into<String>) -> Self
The unique identifier of a customer profile.
Sourcepub fn set_profile_id(self, input: Option<String>) -> Self
pub fn set_profile_id(self, input: Option<String>) -> Self
The unique identifier of a customer profile.
Sourcepub fn get_profile_id(&self) -> &Option<String>
pub fn get_profile_id(&self) -> &Option<String>
The unique identifier of a customer profile.
Sourcepub fn account_number(self, input: impl Into<String>) -> Self
pub fn account_number(self, input: impl Into<String>) -> Self
An account number that you have given to the customer.
Sourcepub fn set_account_number(self, input: Option<String>) -> Self
pub fn set_account_number(self, input: Option<String>) -> Self
An account number that you have given to the customer.
Sourcepub fn get_account_number(&self) -> &Option<String>
pub fn get_account_number(&self) -> &Option<String>
An account number that you have given to the customer.
Sourcepub fn additional_information(self, input: impl Into<String>) -> Self
pub fn additional_information(self, input: impl Into<String>) -> Self
Any additional information relevant to the customer’s profile.
Sourcepub fn set_additional_information(self, input: Option<String>) -> Self
pub fn set_additional_information(self, input: Option<String>) -> Self
Any additional information relevant to the customer’s profile.
Sourcepub fn get_additional_information(&self) -> &Option<String>
pub fn get_additional_information(&self) -> &Option<String>
Any additional information relevant to the customer’s profile.
Sourcepub fn party_type(self, input: PartyType) -> Self
pub fn party_type(self, input: PartyType) -> Self
The type of profile used to describe the customer.
Sourcepub fn set_party_type(self, input: Option<PartyType>) -> Self
pub fn set_party_type(self, input: Option<PartyType>) -> Self
The type of profile used to describe the customer.
Sourcepub fn get_party_type(&self) -> &Option<PartyType>
pub fn get_party_type(&self) -> &Option<PartyType>
The type of profile used to describe the customer.
Sourcepub fn business_name(self, input: impl Into<String>) -> Self
pub fn business_name(self, input: impl Into<String>) -> Self
The name of the customer’s business.
Sourcepub fn set_business_name(self, input: Option<String>) -> Self
pub fn set_business_name(self, input: Option<String>) -> Self
The name of the customer’s business.
Sourcepub fn get_business_name(&self) -> &Option<String>
pub fn get_business_name(&self) -> &Option<String>
The name of the customer’s business.
Sourcepub fn first_name(self, input: impl Into<String>) -> Self
pub fn first_name(self, input: impl Into<String>) -> Self
The customer’s first name.
Sourcepub fn set_first_name(self, input: Option<String>) -> Self
pub fn set_first_name(self, input: Option<String>) -> Self
The customer’s first name.
Sourcepub fn get_first_name(&self) -> &Option<String>
pub fn get_first_name(&self) -> &Option<String>
The customer’s first name.
Sourcepub fn middle_name(self, input: impl Into<String>) -> Self
pub fn middle_name(self, input: impl Into<String>) -> Self
The customer’s middle name.
Sourcepub fn set_middle_name(self, input: Option<String>) -> Self
pub fn set_middle_name(self, input: Option<String>) -> Self
The customer’s middle name.
Sourcepub fn get_middle_name(&self) -> &Option<String>
pub fn get_middle_name(&self) -> &Option<String>
The customer’s middle name.
Sourcepub fn set_last_name(self, input: Option<String>) -> Self
pub fn set_last_name(self, input: Option<String>) -> Self
The customer’s last name.
Sourcepub fn get_last_name(&self) -> &Option<String>
pub fn get_last_name(&self) -> &Option<String>
The customer’s last name.
Sourcepub fn birth_date(self, input: impl Into<String>) -> Self
pub fn birth_date(self, input: impl Into<String>) -> Self
The customer’s birth date.
Sourcepub fn set_birth_date(self, input: Option<String>) -> Self
pub fn set_birth_date(self, input: Option<String>) -> Self
The customer’s birth date.
Sourcepub fn get_birth_date(&self) -> &Option<String>
pub fn get_birth_date(&self) -> &Option<String>
The customer’s birth date.
Sourcepub fn set_gender(self, input: Option<Gender>) -> Self
pub fn set_gender(self, input: Option<Gender>) -> Self
The gender with which the customer identifies.
Sourcepub fn get_gender(&self) -> &Option<Gender>
pub fn get_gender(&self) -> &Option<Gender>
The gender with which the customer identifies.
Sourcepub fn phone_number(self, input: impl Into<String>) -> Self
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.
Sourcepub fn set_phone_number(self, input: Option<String>) -> Self
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.
Sourcepub fn get_phone_number(&self) -> &Option<String>
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.
Sourcepub fn mobile_phone_number(self, input: impl Into<String>) -> Self
pub fn mobile_phone_number(self, input: impl Into<String>) -> Self
The customer’s mobile phone number.
Sourcepub fn set_mobile_phone_number(self, input: Option<String>) -> Self
pub fn set_mobile_phone_number(self, input: Option<String>) -> Self
The customer’s mobile phone number.
Sourcepub fn get_mobile_phone_number(&self) -> &Option<String>
pub fn get_mobile_phone_number(&self) -> &Option<String>
The customer’s mobile phone number.
Sourcepub fn home_phone_number(self, input: impl Into<String>) -> Self
pub fn home_phone_number(self, input: impl Into<String>) -> Self
The customer’s home phone number.
Sourcepub fn set_home_phone_number(self, input: Option<String>) -> Self
pub fn set_home_phone_number(self, input: Option<String>) -> Self
The customer’s home phone number.
Sourcepub fn get_home_phone_number(&self) -> &Option<String>
pub fn get_home_phone_number(&self) -> &Option<String>
The customer’s home phone number.
Sourcepub fn business_phone_number(self, input: impl Into<String>) -> Self
pub fn business_phone_number(self, input: impl Into<String>) -> Self
The customer’s home phone number.
Sourcepub fn set_business_phone_number(self, input: Option<String>) -> Self
pub fn set_business_phone_number(self, input: Option<String>) -> Self
The customer’s home phone number.
Sourcepub fn get_business_phone_number(&self) -> &Option<String>
pub fn get_business_phone_number(&self) -> &Option<String>
The customer’s home phone number.
Sourcepub fn email_address(self, input: impl Into<String>) -> Self
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.
Sourcepub fn set_email_address(self, input: Option<String>) -> Self
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.
Sourcepub fn get_email_address(&self) -> &Option<String>
pub fn get_email_address(&self) -> &Option<String>
The customer’s email address, which has not been specified as a personal or business address.
Sourcepub fn personal_email_address(self, input: impl Into<String>) -> Self
pub fn personal_email_address(self, input: impl Into<String>) -> Self
The customer’s personal email address.
Sourcepub fn set_personal_email_address(self, input: Option<String>) -> Self
pub fn set_personal_email_address(self, input: Option<String>) -> Self
The customer’s personal email address.
Sourcepub fn get_personal_email_address(&self) -> &Option<String>
pub fn get_personal_email_address(&self) -> &Option<String>
The customer’s personal email address.
Sourcepub fn business_email_address(self, input: impl Into<String>) -> Self
pub fn business_email_address(self, input: impl Into<String>) -> Self
The customer’s business email address.
Sourcepub fn set_business_email_address(self, input: Option<String>) -> Self
pub fn set_business_email_address(self, input: Option<String>) -> Self
The customer’s business email address.
Sourcepub fn get_business_email_address(&self) -> &Option<String>
pub fn get_business_email_address(&self) -> &Option<String>
The customer’s business email address.
Sourcepub fn address(self, input: Address) -> Self
pub fn address(self, input: Address) -> Self
A generic address associated with the customer that is not mailing, shipping, or billing.
Sourcepub fn set_address(self, input: Option<Address>) -> Self
pub fn set_address(self, input: Option<Address>) -> Self
A generic address associated with the customer that is not mailing, shipping, or billing.
Sourcepub fn get_address(&self) -> &Option<Address>
pub fn get_address(&self) -> &Option<Address>
A generic address associated with the customer that is not mailing, shipping, or billing.
Sourcepub fn shipping_address(self, input: Address) -> Self
pub fn shipping_address(self, input: Address) -> Self
The customer’s shipping address.
Sourcepub fn set_shipping_address(self, input: Option<Address>) -> Self
pub fn set_shipping_address(self, input: Option<Address>) -> Self
The customer’s shipping address.
Sourcepub fn get_shipping_address(&self) -> &Option<Address>
pub fn get_shipping_address(&self) -> &Option<Address>
The customer’s shipping address.
Sourcepub fn mailing_address(self, input: Address) -> Self
pub fn mailing_address(self, input: Address) -> Self
The customer’s mailing address.
Sourcepub fn set_mailing_address(self, input: Option<Address>) -> Self
pub fn set_mailing_address(self, input: Option<Address>) -> Self
The customer’s mailing address.
Sourcepub fn get_mailing_address(&self) -> &Option<Address>
pub fn get_mailing_address(&self) -> &Option<Address>
The customer’s mailing address.
Sourcepub fn billing_address(self, input: Address) -> Self
pub fn billing_address(self, input: Address) -> Self
The customer’s billing address.
Sourcepub fn set_billing_address(self, input: Option<Address>) -> Self
pub fn set_billing_address(self, input: Option<Address>) -> Self
The customer’s billing address.
Sourcepub fn get_billing_address(&self) -> &Option<Address>
pub fn get_billing_address(&self) -> &Option<Address>
The customer’s billing address.
Sourcepub fn attributes(self, k: impl Into<String>, v: impl Into<String>) -> Self
pub fn attributes(self, k: impl Into<String>, v: impl Into<String>) -> Self
Adds a key-value pair to attributes
.
To override the contents of this collection use set_attributes
.
A key value pair of attributes of a customer profile.
Sourcepub fn set_attributes(self, input: Option<HashMap<String, String>>) -> Self
pub fn set_attributes(self, input: Option<HashMap<String, String>>) -> Self
A key value pair of attributes of a customer profile.
Sourcepub fn get_attributes(&self) -> &Option<HashMap<String, String>>
pub fn get_attributes(&self) -> &Option<HashMap<String, String>>
A key value pair of attributes of a customer profile.
Sourcepub fn found_by_items(self, input: FoundByKeyValue) -> Self
pub fn found_by_items(self, input: FoundByKeyValue) -> Self
Appends an item to found_by_items
.
To override the contents of this collection use set_found_by_items
.
A list of items used to find a profile returned in a SearchProfiles response. An item is a key-value(s) pair that matches an attribute in the profile.
If the optional AdditionalSearchKeys
parameter was included in the SearchProfiles request, the FoundByItems
list should be interpreted based on the LogicalOperator
used in the request:
-
AND
- The profile included in the response matched all of the search keys specified in the request. TheFoundByItems
will include all of the key-value(s) pairs that were specified in the request (as this is a requirement ofAND
search logic). -
OR
- The profile included in the response matched at least one of the search keys specified in the request. TheFoundByItems
will include each of the key-value(s) pairs that the profile was found by.
The OR
relationship is the default behavior if the LogicalOperator
parameter is not included in the SearchProfiles request.
Sourcepub fn set_found_by_items(self, input: Option<Vec<FoundByKeyValue>>) -> Self
pub fn set_found_by_items(self, input: Option<Vec<FoundByKeyValue>>) -> Self
A list of items used to find a profile returned in a SearchProfiles response. An item is a key-value(s) pair that matches an attribute in the profile.
If the optional AdditionalSearchKeys
parameter was included in the SearchProfiles request, the FoundByItems
list should be interpreted based on the LogicalOperator
used in the request:
-
AND
- The profile included in the response matched all of the search keys specified in the request. TheFoundByItems
will include all of the key-value(s) pairs that were specified in the request (as this is a requirement ofAND
search logic). -
OR
- The profile included in the response matched at least one of the search keys specified in the request. TheFoundByItems
will include each of the key-value(s) pairs that the profile was found by.
The OR
relationship is the default behavior if the LogicalOperator
parameter is not included in the SearchProfiles request.
Sourcepub fn get_found_by_items(&self) -> &Option<Vec<FoundByKeyValue>>
pub fn get_found_by_items(&self) -> &Option<Vec<FoundByKeyValue>>
A list of items used to find a profile returned in a SearchProfiles response. An item is a key-value(s) pair that matches an attribute in the profile.
If the optional AdditionalSearchKeys
parameter was included in the SearchProfiles request, the FoundByItems
list should be interpreted based on the LogicalOperator
used in the request:
-
AND
- The profile included in the response matched all of the search keys specified in the request. TheFoundByItems
will include all of the key-value(s) pairs that were specified in the request (as this is a requirement ofAND
search logic). -
OR
- The profile included in the response matched at least one of the search keys specified in the request. TheFoundByItems
will include each of the key-value(s) pairs that the profile was found by.
The OR
relationship is the default behavior if the LogicalOperator
parameter is not included in the SearchProfiles request.
Sourcepub fn party_type_string(self, input: impl Into<String>) -> Self
pub fn party_type_string(self, input: impl Into<String>) -> Self
An alternative to PartyType which accepts any string as input.
Sourcepub fn set_party_type_string(self, input: Option<String>) -> Self
pub fn set_party_type_string(self, input: Option<String>) -> Self
An alternative to PartyType which accepts any string as input.
Sourcepub fn get_party_type_string(&self) -> &Option<String>
pub fn get_party_type_string(&self) -> &Option<String>
An alternative to PartyType which accepts any string as input.
Sourcepub fn gender_string(self, input: impl Into<String>) -> Self
pub fn gender_string(self, input: impl Into<String>) -> Self
An alternative to Gender which accepts any string as input.
Sourcepub fn set_gender_string(self, input: Option<String>) -> Self
pub fn set_gender_string(self, input: Option<String>) -> Self
An alternative to Gender which accepts any string as input.
Sourcepub fn get_gender_string(&self) -> &Option<String>
pub fn get_gender_string(&self) -> &Option<String>
An alternative to Gender which accepts any string as input.
Trait Implementations§
Source§impl Clone for ProfileBuilder
impl Clone for ProfileBuilder
Source§fn clone(&self) -> ProfileBuilder
fn clone(&self) -> ProfileBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for ProfileBuilder
impl Debug for ProfileBuilder
Source§impl Default for ProfileBuilder
impl Default for ProfileBuilder
Source§fn default() -> ProfileBuilder
fn default() -> ProfileBuilder
Source§impl PartialEq for ProfileBuilder
impl PartialEq for ProfileBuilder
impl StructuralPartialEq for ProfileBuilder
Auto Trait Implementations§
impl Freeze for ProfileBuilder
impl RefUnwindSafe for ProfileBuilder
impl Send for ProfileBuilder
impl Sync for ProfileBuilder
impl Unpin for ProfileBuilder
impl UnwindSafe for ProfileBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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 moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
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 bright_black(&self) -> Painted<&T>
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>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
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>
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>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
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>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
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>
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>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
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>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
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>
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>
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>
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>
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>
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>
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 underline(&self) -> Painted<&T>
fn underline(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::Underline
.
§Example
println!("{}", value.underline());
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::RapidBlink
.
§Example
println!("{}", value.rapid_blink());
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
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 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.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
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);