#[non_exhaustive]pub struct Profile {Show 25 fields
pub profile_id: Option<String>,
pub account_number: Option<String>,
pub additional_information: Option<String>,
pub party_type: Option<PartyType>,
pub business_name: Option<String>,
pub first_name: Option<String>,
pub middle_name: Option<String>,
pub last_name: Option<String>,
pub birth_date: Option<String>,
pub gender: Option<Gender>,
pub phone_number: Option<String>,
pub mobile_phone_number: Option<String>,
pub home_phone_number: Option<String>,
pub business_phone_number: Option<String>,
pub email_address: Option<String>,
pub personal_email_address: Option<String>,
pub business_email_address: Option<String>,
pub address: Option<Address>,
pub shipping_address: Option<Address>,
pub mailing_address: Option<Address>,
pub billing_address: Option<Address>,
pub attributes: Option<HashMap<String, String>>,
pub found_by_items: Option<Vec<FoundByKeyValue>>,
pub party_type_string: Option<String>,
pub gender_string: Option<String>,
}Expand description
The standard profile of a customer.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.profile_id: Option<String>The unique identifier of a customer profile.
account_number: Option<String>An account number that you have given to the customer.
additional_information: Option<String>Any additional information relevant to the customer’s profile.
party_type: Option<PartyType>The type of profile used to describe the customer.
business_name: Option<String>The name of the customer’s business.
first_name: Option<String>The customer’s first name.
middle_name: Option<String>The customer’s middle name.
last_name: Option<String>The customer’s last name.
birth_date: Option<String>The customer’s birth date.
gender: Option<Gender>The gender with which the customer identifies.
phone_number: Option<String>The customer's phone number, which has not been specified as a mobile, home, or business number.
mobile_phone_number: Option<String>The customer’s mobile phone number.
home_phone_number: Option<String>The customer’s home phone number.
business_phone_number: Option<String>The customer’s home phone number.
email_address: Option<String>The customer’s email address, which has not been specified as a personal or business address.
personal_email_address: Option<String>The customer’s personal email address.
business_email_address: Option<String>The customer’s business email address.
address: Option<Address>A generic address associated with the customer that is not mailing, shipping, or billing.
shipping_address: Option<Address>The customer’s shipping address.
mailing_address: Option<Address>The customer’s mailing address.
billing_address: Option<Address>The customer’s billing address.
attributes: Option<HashMap<String, String>>A key value pair of attributes of a customer profile.
found_by_items: 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. TheFoundByItemswill include all of the key-value(s) pairs that were specified in the request (as this is a requirement ofANDsearch logic). -
OR- The profile included in the response matched at least one of the search keys specified in the request. TheFoundByItemswill 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.
party_type_string: Option<String>An alternative to PartyType which accepts any string as input.
gender_string: Option<String>An alternative to Gender which accepts any string as input.
Implementations§
Source§impl Profile
impl Profile
Sourcepub fn profile_id(&self) -> Option<&str>
pub fn profile_id(&self) -> Option<&str>
The unique identifier of a customer profile.
Sourcepub fn account_number(&self) -> Option<&str>
pub fn account_number(&self) -> Option<&str>
An account number that you have given to the customer.
Sourcepub fn additional_information(&self) -> Option<&str>
pub fn additional_information(&self) -> Option<&str>
Any additional information relevant to the customer’s profile.
Sourcepub fn party_type(&self) -> Option<&PartyType>
pub fn party_type(&self) -> Option<&PartyType>
The type of profile used to describe the customer.
Sourcepub fn business_name(&self) -> Option<&str>
pub fn business_name(&self) -> Option<&str>
The name of the customer’s business.
Sourcepub fn first_name(&self) -> Option<&str>
pub fn first_name(&self) -> Option<&str>
The customer’s first name.
Sourcepub fn middle_name(&self) -> Option<&str>
pub fn middle_name(&self) -> Option<&str>
The customer’s middle name.
Sourcepub fn birth_date(&self) -> Option<&str>
pub fn birth_date(&self) -> Option<&str>
The customer’s birth date.
Sourcepub fn phone_number(&self) -> Option<&str>
pub fn phone_number(&self) -> Option<&str>
The customer's phone number, which has not been specified as a mobile, home, or business number.
Sourcepub fn mobile_phone_number(&self) -> Option<&str>
pub fn mobile_phone_number(&self) -> Option<&str>
The customer’s mobile phone number.
Sourcepub fn home_phone_number(&self) -> Option<&str>
pub fn home_phone_number(&self) -> Option<&str>
The customer’s home phone number.
Sourcepub fn business_phone_number(&self) -> Option<&str>
pub fn business_phone_number(&self) -> Option<&str>
The customer’s home phone number.
Sourcepub fn email_address(&self) -> Option<&str>
pub fn email_address(&self) -> Option<&str>
The customer’s email address, which has not been specified as a personal or business address.
Sourcepub fn personal_email_address(&self) -> Option<&str>
pub fn personal_email_address(&self) -> Option<&str>
The customer’s personal email address.
Sourcepub fn business_email_address(&self) -> Option<&str>
pub fn business_email_address(&self) -> Option<&str>
The customer’s business email address.
Sourcepub fn address(&self) -> Option<&Address>
pub fn address(&self) -> Option<&Address>
A generic address associated with the customer that is not mailing, shipping, or billing.
Sourcepub fn shipping_address(&self) -> Option<&Address>
pub fn shipping_address(&self) -> Option<&Address>
The customer’s shipping address.
Sourcepub fn mailing_address(&self) -> Option<&Address>
pub fn mailing_address(&self) -> Option<&Address>
The customer’s mailing address.
Sourcepub fn billing_address(&self) -> Option<&Address>
pub fn billing_address(&self) -> Option<&Address>
The customer’s billing address.
Sourcepub fn attributes(&self) -> Option<&HashMap<String, String>>
pub fn attributes(&self) -> Option<&HashMap<String, String>>
A key value pair of attributes of a customer profile.
Sourcepub fn found_by_items(&self) -> &[FoundByKeyValue]
pub fn found_by_items(&self) -> &[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. TheFoundByItemswill include all of the key-value(s) pairs that were specified in the request (as this is a requirement ofANDsearch logic). -
OR- The profile included in the response matched at least one of the search keys specified in the request. TheFoundByItemswill 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.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .found_by_items.is_none().
Sourcepub fn party_type_string(&self) -> Option<&str>
pub fn party_type_string(&self) -> Option<&str>
An alternative to PartyType which accepts any string as input.
Sourcepub fn gender_string(&self) -> Option<&str>
pub fn gender_string(&self) -> Option<&str>
An alternative to Gender which accepts any string as input.
Trait Implementations§
impl StructuralPartialEq for Profile
Auto Trait Implementations§
impl Freeze for Profile
impl RefUnwindSafe for Profile
impl Send for Profile
impl Sync for Profile
impl Unpin for Profile
impl UnwindSafe for Profile
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);