Struct UserBuilder

Source

#[non_exhaustive]
pub struct UserBuilder { /* private fields */ }

Expand description

A builder for User.

Implementations§

Source §

impl UserBuilder

Source

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

The user ID.

This field is required.

Source

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

The user ID.

Source

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

The user ID.

Source

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

The Amazon Chime account ID.

Source

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

The Amazon Chime account ID.

Source

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

The Amazon Chime account ID.

Source

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

The primary email address of the user.

Source

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

The primary email address of the user.

Source

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

The primary email address of the user.

Source

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

The primary phone number associated with the user.

Source

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

The primary phone number associated with the user.

Source

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

The primary phone number associated with the user.

Source

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

The display name of the user.

Source

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

The display name of the user.

Source

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

The display name of the user.

Source

pub fn license_type(self, input: License) -> Self

The license type for the user.

Source

pub fn set_license_type(self, input: Option<License>) -> Self

The license type for the user.

Source

pub fn get_license_type(&self) -> &Option<License>

The license type for the user.

Source

pub fn user_type(self, input: UserType) -> Self

The user type.

Source

pub fn set_user_type(self, input: Option<UserType>) -> Self

The user type.

Source

pub fn get_user_type(&self) -> &Option<UserType>

The user type.

Source

pub fn user_registration_status(self, input: RegistrationStatus) -> Self

The user registration status.

Source

pub fn set_user_registration_status( self, input: Option<RegistrationStatus>, ) -> Self

The user registration status.

Source

pub fn get_user_registration_status(&self) -> &Option<RegistrationStatus>

The user registration status.

Source

pub fn user_invitation_status(self, input: InviteStatus) -> Self

The user invite status.

Source

pub fn set_user_invitation_status(self, input: Option<InviteStatus>) -> Self

The user invite status.

Source

pub fn get_user_invitation_status(&self) -> &Option<InviteStatus>

The user invite status.

Source

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

Date and time when the user is registered, in ISO 8601 format.

Source

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

Date and time when the user is registered, in ISO 8601 format.

Source

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

Date and time when the user is registered, in ISO 8601 format.

Source

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

Date and time when the user is invited to the Amazon Chime account, in ISO 8601 format.

Source

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

Date and time when the user is invited to the Amazon Chime account, in ISO 8601 format.

Source

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

Date and time when the user is invited to the Amazon Chime account, in ISO 8601 format.

Source

pub fn alexa_for_business_metadata( self, input: AlexaForBusinessMetadata, ) -> Self

The Alexa for Business metadata.

Source

pub fn set_alexa_for_business_metadata( self, input: Option<AlexaForBusinessMetadata>, ) -> Self

The Alexa for Business metadata.

Source

pub fn get_alexa_for_business_metadata( &self, ) -> &Option<AlexaForBusinessMetadata>

The Alexa for Business metadata.

Source

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

The user's personal meeting PIN.

Source

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

The user's personal meeting PIN.

Source

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

The user's personal meeting PIN.

Source

pub fn build(self) -> Result<User, BuildError>

Consumes the builder and constructs a User. This method will fail if any of the following fields are not set:

user_id

Trait Implementations§

Source §

impl Clone for UserBuilder

Source §

fn clone(&self) -> UserBuilder

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

Source §

impl Debug for UserBuilder

Source §

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

Formats the value using the given formatter. Read more

Source §

impl Default for UserBuilder

Source §

fn default() -> UserBuilder

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

Source §

impl PartialEq for UserBuilder

Source §

fn eq(&self, other: &UserBuilder) -> bool

Tests for self and other values to be equal, and is used by ==.

1.0.0 · Source§

const 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 UserBuilder

Auto Trait Implementations§

§

impl UnwindSafe for UserBuilder

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 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());

Source §

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

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

§Example

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

Source §

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

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 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>::Error>

Performs the conversion.

Source §

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

Source §

type Error = >::Error

The type returned in the event of a conversion error.

Source §

fn try_into(self) -> Result<U, >::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 §

Struct UserBuilderCopy item path

Implementations§

impl UserBuilder

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

pub fn license_type(self, input: License) -> Self

pub fn set_license_type(self, input: Option<License>) -> Self

pub fn get_license_type(&self) -> &Option<License>

pub fn user_type(self, input: UserType) -> Self

pub fn set_user_type(self, input: Option<UserType>) -> Self

pub fn get_user_type(&self) -> &Option<UserType>

pub fn user_registration_status(self, input: RegistrationStatus) -> Self

pub fn set_user_registration_status( self, input: Option<RegistrationStatus>, ) -> Self

pub fn get_user_registration_status(&self) -> &Option<RegistrationStatus>

pub fn user_invitation_status(self, input: InviteStatus) -> Self

pub fn set_user_invitation_status(self, input: Option<InviteStatus>) -> Self

pub fn get_user_invitation_status(&self) -> &Option<InviteStatus>

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

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

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

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

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

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

pub fn alexa_for_business_metadata( self, input: AlexaForBusinessMetadata, ) -> Self

pub fn set_alexa_for_business_metadata( self, input: Option<AlexaForBusinessMetadata>, ) -> Self

pub fn get_alexa_for_business_metadata( &self, ) -> &Option<AlexaForBusinessMetadata>

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

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

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

pub fn build(self) -> Result<User, BuildError>

Trait Implementations§

impl Clone for UserBuilder

fn clone(&self) -> UserBuilder

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

impl Debug for UserBuilder

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

impl Default for UserBuilder

fn default() -> UserBuilder

impl PartialEq for UserBuilder

fn eq(&self, other: &UserBuilder) -> bool

const fn ne(&self, other: &Rhs) -> bool

impl StructuralPartialEq for UserBuilder

Auto Trait Implementations§

impl Freeze for UserBuilder

impl RefUnwindSafe for UserBuilder

impl Send for UserBuilder

impl Sync for UserBuilder

impl Unpin for UserBuilder

impl UnwindSafe for UserBuilder

Blanket Implementations§

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> CloneToUninit for Twhere T: Clone,

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

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

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

fn in_current_span(self) -> Instrumented<Self>

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

fn into(self) -> U

impl<T> IntoEither for T

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

Struct UserBuilder

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

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

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

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

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

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

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

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