WorkspaceDescriptionBuilder

aws_sdk_grafana::types::builders

Struct WorkspaceDescriptionBuilder 

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

A builder for WorkspaceDescription.

Implementations§

Source§

impl WorkspaceDescriptionBuilder

Source

pub fn account_access_type(self, input: AccountAccessType) -> Self

Specifies whether the workspace can access Amazon Web Services resources in this Amazon Web Services account only, or whether it can also access Amazon Web Services resources in other accounts in the same organization. If this is ORGANIZATION, the workspaceOrganizationalUnits parameter specifies which organizational units the workspace can access.

Source

pub fn set_account_access_type(self, input: Option<AccountAccessType>) -> Self

Specifies whether the workspace can access Amazon Web Services resources in this Amazon Web Services account only, or whether it can also access Amazon Web Services resources in other accounts in the same organization. If this is ORGANIZATION, the workspaceOrganizationalUnits parameter specifies which organizational units the workspace can access.

Source

pub fn get_account_access_type(&self) -> &Option<AccountAccessType>

Specifies whether the workspace can access Amazon Web Services resources in this Amazon Web Services account only, or whether it can also access Amazon Web Services resources in other accounts in the same organization. If this is ORGANIZATION, the workspaceOrganizationalUnits parameter specifies which organizational units the workspace can access.

Source

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

The date that the workspace was created.

This field is required.
Source

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

The date that the workspace was created.

Source

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

The date that the workspace was created.

Source

pub fn data_sources(self, input: DataSourceType) -> Self

Appends an item to data_sources.

To override the contents of this collection use set_data_sources.

Specifies the Amazon Web Services data sources that have been configured to have IAM roles and permissions created to allow Amazon Managed Grafana to read data from these sources.

This list is only used when the workspace was created through the Amazon Web Services console, and the permissionType is SERVICE_MANAGED.

Source

pub fn set_data_sources(self, input: Option<Vec<DataSourceType>>) -> Self

Specifies the Amazon Web Services data sources that have been configured to have IAM roles and permissions created to allow Amazon Managed Grafana to read data from these sources.

This list is only used when the workspace was created through the Amazon Web Services console, and the permissionType is SERVICE_MANAGED.

Source

pub fn get_data_sources(&self) -> &Option<Vec<DataSourceType>>

Specifies the Amazon Web Services data sources that have been configured to have IAM roles and permissions created to allow Amazon Managed Grafana to read data from these sources.

This list is only used when the workspace was created through the Amazon Web Services console, and the permissionType is SERVICE_MANAGED.

Source

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

The user-defined description of the workspace.

Source

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

The user-defined description of the workspace.

Source

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

The user-defined description of the workspace.

Source

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

The URL that users can use to access the Grafana console in the workspace.

This field is required.
Source

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

The URL that users can use to access the Grafana console in the workspace.

Source

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

The URL that users can use to access the Grafana console in the workspace.

Source

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

The version of Grafana supported in this workspace.

This field is required.
Source

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

The version of Grafana supported in this workspace.

Source

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

The version of Grafana supported in this workspace.

Source

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

The unique ID of this workspace.

This field is required.
Source

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

The unique ID of this workspace.

Source

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

The unique ID of this workspace.

Source

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

The most recent date that the workspace was modified.

This field is required.
Source

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

The most recent date that the workspace was modified.

Source

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

The most recent date that the workspace was modified.

Source

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

The name of the workspace.

Source

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

The name of the workspace.

Source

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

The name of the workspace.

Source

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

The name of the IAM role that is used to access resources through Organizations.

Source

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

The name of the IAM role that is used to access resources through Organizations.

Source

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

The name of the IAM role that is used to access resources through Organizations.

Source

pub fn notification_destinations( self, input: NotificationDestinationType, ) -> Self

Appends an item to notification_destinations.

To override the contents of this collection use set_notification_destinations.

The Amazon Web Services notification channels that Amazon Managed Grafana can automatically create IAM roles and permissions for, to allow Amazon Managed Grafana to use these channels.

Source

pub fn set_notification_destinations( self, input: Option<Vec<NotificationDestinationType>>, ) -> Self

The Amazon Web Services notification channels that Amazon Managed Grafana can automatically create IAM roles and permissions for, to allow Amazon Managed Grafana to use these channels.

Source

pub fn get_notification_destinations( &self, ) -> &Option<Vec<NotificationDestinationType>>

The Amazon Web Services notification channels that Amazon Managed Grafana can automatically create IAM roles and permissions for, to allow Amazon Managed Grafana to use these channels.

Source

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

Appends an item to organizational_units.

To override the contents of this collection use set_organizational_units.

Specifies the organizational units that this workspace is allowed to use data sources from, if this workspace is in an account that is part of an organization.

Source

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

Specifies the organizational units that this workspace is allowed to use data sources from, if this workspace is in an account that is part of an organization.

Source

pub fn get_organizational_units(&self) -> &Option<Vec<String>>

Specifies the organizational units that this workspace is allowed to use data sources from, if this workspace is in an account that is part of an organization.

Source

pub fn permission_type(self, input: PermissionType) -> Self

If this is SERVICE_MANAGED, and the workplace was created through the Amazon Managed Grafana console, then Amazon Managed Grafana automatically creates the IAM roles and provisions the permissions that the workspace needs to use Amazon Web Services data sources and notification channels.

If this is CUSTOMER_MANAGED, you must manage those roles and permissions yourself.

If you are working with a workspace in a member account of an organization and that account is not a delegated administrator account, and you want the workspace to access data sources in other Amazon Web Services accounts in the organization, this parameter must be set to CUSTOMER_MANAGED.

For more information about converting between customer and service managed, see Managing permissions for data sources and notification channels. For more information about the roles and permissions that must be managed for customer managed workspaces, see Amazon Managed Grafana permissions and policies for Amazon Web Services data sources and notification channels

Source

pub fn set_permission_type(self, input: Option<PermissionType>) -> Self

If this is SERVICE_MANAGED, and the workplace was created through the Amazon Managed Grafana console, then Amazon Managed Grafana automatically creates the IAM roles and provisions the permissions that the workspace needs to use Amazon Web Services data sources and notification channels.

If this is CUSTOMER_MANAGED, you must manage those roles and permissions yourself.

If you are working with a workspace in a member account of an organization and that account is not a delegated administrator account, and you want the workspace to access data sources in other Amazon Web Services accounts in the organization, this parameter must be set to CUSTOMER_MANAGED.

For more information about converting between customer and service managed, see Managing permissions for data sources and notification channels. For more information about the roles and permissions that must be managed for customer managed workspaces, see Amazon Managed Grafana permissions and policies for Amazon Web Services data sources and notification channels

Source

pub fn get_permission_type(&self) -> &Option<PermissionType>

If this is SERVICE_MANAGED, and the workplace was created through the Amazon Managed Grafana console, then Amazon Managed Grafana automatically creates the IAM roles and provisions the permissions that the workspace needs to use Amazon Web Services data sources and notification channels.

If this is CUSTOMER_MANAGED, you must manage those roles and permissions yourself.

If you are working with a workspace in a member account of an organization and that account is not a delegated administrator account, and you want the workspace to access data sources in other Amazon Web Services accounts in the organization, this parameter must be set to CUSTOMER_MANAGED.

For more information about converting between customer and service managed, see Managing permissions for data sources and notification channels. For more information about the roles and permissions that must be managed for customer managed workspaces, see Amazon Managed Grafana permissions and policies for Amazon Web Services data sources and notification channels

Source

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

The name of the CloudFormation stack set that is used to generate IAM roles to be used for this workspace.

Source

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

The name of the CloudFormation stack set that is used to generate IAM roles to be used for this workspace.

Source

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

The name of the CloudFormation stack set that is used to generate IAM roles to be used for this workspace.

Source

pub fn status(self, input: WorkspaceStatus) -> Self

The current status of the workspace.

This field is required.
Source

pub fn set_status(self, input: Option<WorkspaceStatus>) -> Self

The current status of the workspace.

Source

pub fn get_status(&self) -> &Option<WorkspaceStatus>

The current status of the workspace.

Source

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

The IAM role that grants permissions to the Amazon Web Services resources that the workspace will view data from. This role must already exist.

Source

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

The IAM role that grants permissions to the Amazon Web Services resources that the workspace will view data from. This role must already exist.

Source

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

The IAM role that grants permissions to the Amazon Web Services resources that the workspace will view data from. This role must already exist.

Source

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

Specifies whether this workspace has a full Grafana Enterprise license.

Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials.

Source

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

Specifies whether this workspace has a full Grafana Enterprise license.

Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials.

Source

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

Specifies whether this workspace has a full Grafana Enterprise license.

Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials.

Source

pub fn free_trial_consumed(self, input: bool) -> Self

Specifies whether this workspace has already fully used its free trial for Grafana Enterprise.

Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials.

Source

pub fn set_free_trial_consumed(self, input: Option<bool>) -> Self

Specifies whether this workspace has already fully used its free trial for Grafana Enterprise.

Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials.

Source

pub fn get_free_trial_consumed(&self) -> &Option<bool>

Specifies whether this workspace has already fully used its free trial for Grafana Enterprise.

Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials.

Source

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

If this workspace has a full Grafana Enterprise license purchased through Amazon Web Services Marketplace, this specifies when the license ends and will need to be renewed. Purchasing the Enterprise plugins option through Amazon Managed Grafana does not have an expiration. It is valid until the license is removed.

Source

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

If this workspace has a full Grafana Enterprise license purchased through Amazon Web Services Marketplace, this specifies when the license ends and will need to be renewed. Purchasing the Enterprise plugins option through Amazon Managed Grafana does not have an expiration. It is valid until the license is removed.

Source

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

If this workspace has a full Grafana Enterprise license purchased through Amazon Web Services Marketplace, this specifies when the license ends and will need to be renewed. Purchasing the Enterprise plugins option through Amazon Managed Grafana does not have an expiration. It is valid until the license is removed.

Source

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

If this workspace is currently in the free trial period for Grafana Enterprise, this value specifies when that free trial ends.

Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials.

Source

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

If this workspace is currently in the free trial period for Grafana Enterprise, this value specifies when that free trial ends.

Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials.

Source

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

If this workspace is currently in the free trial period for Grafana Enterprise, this value specifies when that free trial ends.

Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials.

Source

pub fn authentication(self, input: AuthenticationSummary) -> Self

A structure that describes whether the workspace uses SAML, IAM Identity Center, or both methods for user authentication.

This field is required.
Source

pub fn set_authentication(self, input: Option<AuthenticationSummary>) -> Self

A structure that describes whether the workspace uses SAML, IAM Identity Center, or both methods for user authentication.

Source

pub fn get_authentication(&self) -> &Option<AuthenticationSummary>

A structure that describes whether the workspace uses SAML, IAM Identity Center, or both methods for user authentication.

Source

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

Adds a key-value pair to tags.

To override the contents of this collection use set_tags.

The list of tags associated with the workspace.

Source

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

The list of tags associated with the workspace.

Source

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

The list of tags associated with the workspace.

Source

pub fn vpc_configuration(self, input: VpcConfiguration) -> Self

The configuration for connecting to data sources in a private VPC (Amazon Virtual Private Cloud).

Source

pub fn set_vpc_configuration(self, input: Option<VpcConfiguration>) -> Self

The configuration for connecting to data sources in a private VPC (Amazon Virtual Private Cloud).

Source

pub fn get_vpc_configuration(&self) -> &Option<VpcConfiguration>

The configuration for connecting to data sources in a private VPC (Amazon Virtual Private Cloud).

Source

pub fn network_access_control(self, input: NetworkAccessConfiguration) -> Self

The configuration settings for network access to your workspace.

Source

pub fn set_network_access_control( self, input: Option<NetworkAccessConfiguration>, ) -> Self

The configuration settings for network access to your workspace.

Source

pub fn get_network_access_control(&self) -> &Option<NetworkAccessConfiguration>

The configuration settings for network access to your workspace.

Source

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

The token that ties this workspace to a Grafana Labs account. For more information, see Link your account with Grafana Labs.

Source

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

The token that ties this workspace to a Grafana Labs account. For more information, see Link your account with Grafana Labs.

Source

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

The token that ties this workspace to a Grafana Labs account. For more information, see Link your account with Grafana Labs.

Source

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

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

Trait Implementations§

Source§

impl Clone for WorkspaceDescriptionBuilder

Source§

fn clone(&self) -> WorkspaceDescriptionBuilder

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 WorkspaceDescriptionBuilder

Source§

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

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

impl Default for WorkspaceDescriptionBuilder

Source§

fn default() -> WorkspaceDescriptionBuilder

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

impl PartialEq for WorkspaceDescriptionBuilder

Source§

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

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,