#[non_exhaustive]pub struct UserTypeBuilder { /* private fields */ }Expand description
A builder for UserType.
Implementations§
Source§impl UserTypeBuilder
impl UserTypeBuilder
Sourcepub fn set_username(self, input: Option<String>) -> Self
pub fn set_username(self, input: Option<String>) -> Self
The user's username.
Sourcepub fn get_username(&self) -> &Option<String>
pub fn get_username(&self) -> &Option<String>
The user's username.
Sourcepub fn attributes(self, input: AttributeType) -> Self
pub fn attributes(self, input: AttributeType) -> Self
Appends an item to attributes.
To override the contents of this collection use set_attributes.
Names and values of a user's attributes, for example email.
Sourcepub fn set_attributes(self, input: Option<Vec<AttributeType>>) -> Self
pub fn set_attributes(self, input: Option<Vec<AttributeType>>) -> Self
Names and values of a user's attributes, for example email.
Sourcepub fn get_attributes(&self) -> &Option<Vec<AttributeType>>
pub fn get_attributes(&self) -> &Option<Vec<AttributeType>>
Names and values of a user's attributes, for example email.
Sourcepub fn user_create_date(self, input: DateTime) -> Self
pub fn user_create_date(self, input: DateTime) -> Self
The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.
Sourcepub fn set_user_create_date(self, input: Option<DateTime>) -> Self
pub fn set_user_create_date(self, input: Option<DateTime>) -> Self
The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.
Sourcepub fn get_user_create_date(&self) -> &Option<DateTime>
pub fn get_user_create_date(&self) -> &Option<DateTime>
The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.
Sourcepub fn user_last_modified_date(self, input: DateTime) -> Self
pub fn user_last_modified_date(self, input: DateTime) -> Self
The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.
Sourcepub fn set_user_last_modified_date(self, input: Option<DateTime>) -> Self
pub fn set_user_last_modified_date(self, input: Option<DateTime>) -> Self
The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.
Sourcepub fn get_user_last_modified_date(&self) -> &Option<DateTime>
pub fn get_user_last_modified_date(&self) -> &Option<DateTime>
The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.
Sourcepub fn enabled(self, input: bool) -> Self
pub fn enabled(self, input: bool) -> Self
Indicates whether the user's account is enabled or disabled.
Sourcepub fn set_enabled(self, input: Option<bool>) -> Self
pub fn set_enabled(self, input: Option<bool>) -> Self
Indicates whether the user's account is enabled or disabled.
Sourcepub fn get_enabled(&self) -> &Option<bool>
pub fn get_enabled(&self) -> &Option<bool>
Indicates whether the user's account is enabled or disabled.
Sourcepub fn user_status(self, input: UserStatusType) -> Self
pub fn user_status(self, input: UserStatusType) -> Self
The user status. This can be one of the following:
-
UNCONFIRMED: User has been created but not confirmed. -
CONFIRMED: User has been confirmed. -
EXTERNAL_PROVIDER: User signed in with a third-party IdP. -
RESET_REQUIRED: User is confirmed, but the user must request a code and reset their password before they can sign in. -
FORCE_CHANGE_PASSWORD: The user is confirmed and the user can sign in using a temporary password, but on first sign-in, the user must change their password to a new value before doing anything else.
The statuses ARCHIVED, UNKNOWN, and COMPROMISED are no longer used.
Sourcepub fn set_user_status(self, input: Option<UserStatusType>) -> Self
pub fn set_user_status(self, input: Option<UserStatusType>) -> Self
The user status. This can be one of the following:
-
UNCONFIRMED: User has been created but not confirmed. -
CONFIRMED: User has been confirmed. -
EXTERNAL_PROVIDER: User signed in with a third-party IdP. -
RESET_REQUIRED: User is confirmed, but the user must request a code and reset their password before they can sign in. -
FORCE_CHANGE_PASSWORD: The user is confirmed and the user can sign in using a temporary password, but on first sign-in, the user must change their password to a new value before doing anything else.
The statuses ARCHIVED, UNKNOWN, and COMPROMISED are no longer used.
Sourcepub fn get_user_status(&self) -> &Option<UserStatusType>
pub fn get_user_status(&self) -> &Option<UserStatusType>
The user status. This can be one of the following:
-
UNCONFIRMED: User has been created but not confirmed. -
CONFIRMED: User has been confirmed. -
EXTERNAL_PROVIDER: User signed in with a third-party IdP. -
RESET_REQUIRED: User is confirmed, but the user must request a code and reset their password before they can sign in. -
FORCE_CHANGE_PASSWORD: The user is confirmed and the user can sign in using a temporary password, but on first sign-in, the user must change their password to a new value before doing anything else.
The statuses ARCHIVED, UNKNOWN, and COMPROMISED are no longer used.
Sourcepub fn mfa_options(self, input: MfaOptionType) -> Self
pub fn mfa_options(self, input: MfaOptionType) -> Self
Appends an item to mfa_options.
To override the contents of this collection use set_mfa_options.
The user's MFA configuration.
Sourcepub fn set_mfa_options(self, input: Option<Vec<MfaOptionType>>) -> Self
pub fn set_mfa_options(self, input: Option<Vec<MfaOptionType>>) -> Self
The user's MFA configuration.
Sourcepub fn get_mfa_options(&self) -> &Option<Vec<MfaOptionType>>
pub fn get_mfa_options(&self) -> &Option<Vec<MfaOptionType>>
The user's MFA configuration.
Trait Implementations§
Source§impl Clone for UserTypeBuilder
impl Clone for UserTypeBuilder
Source§fn clone(&self) -> UserTypeBuilder
fn clone(&self) -> UserTypeBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for UserTypeBuilder
impl Debug for UserTypeBuilder
Source§impl Default for UserTypeBuilder
impl Default for UserTypeBuilder
Source§fn default() -> UserTypeBuilder
fn default() -> UserTypeBuilder
Source§impl PartialEq for UserTypeBuilder
impl PartialEq for UserTypeBuilder
impl StructuralPartialEq for UserTypeBuilder
Auto Trait Implementations§
impl Freeze for UserTypeBuilder
impl RefUnwindSafe for UserTypeBuilder
impl Send for UserTypeBuilder
impl Sync for UserTypeBuilder
impl Unpin for UserTypeBuilder
impl UnwindSafe for UserTypeBuilder
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>
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>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
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>
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>
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>
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>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
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 rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
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);