pub struct CreateWorkspaceFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to CreateWorkspace
.
Creates a workspace. In a workspace, you can create Grafana dashboards and visualizations to analyze your metrics, logs, and traces. You don't have to build, package, or deploy any hardware to run the Grafana server.
Don't use CreateWorkspace
to modify an existing workspace. Instead, use UpdateWorkspace.
Implementations§
Source§impl CreateWorkspaceFluentBuilder
impl CreateWorkspaceFluentBuilder
Sourcepub fn as_input(&self) -> &CreateWorkspaceInputBuilder
pub fn as_input(&self) -> &CreateWorkspaceInputBuilder
Access the CreateWorkspace as a reference.
Sourcepub async fn send(
self,
) -> Result<CreateWorkspaceOutput, SdkError<CreateWorkspaceError, HttpResponse>>
pub async fn send( self, ) -> Result<CreateWorkspaceOutput, SdkError<CreateWorkspaceError, HttpResponse>>
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
Sourcepub fn customize(
self,
) -> CustomizableOperation<CreateWorkspaceOutput, CreateWorkspaceError, Self>
pub fn customize( self, ) -> CustomizableOperation<CreateWorkspaceOutput, CreateWorkspaceError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn account_access_type(self, input: AccountAccessType) -> Self
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 you specify ORGANIZATION
, you must specify which organizational units the workspace can access in the workspaceOrganizationalUnits
parameter.
Sourcepub fn set_account_access_type(self, input: Option<AccountAccessType>) -> Self
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 you specify ORGANIZATION
, you must specify which organizational units the workspace can access in the workspaceOrganizationalUnits
parameter.
Sourcepub fn get_account_access_type(&self) -> &Option<AccountAccessType>
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 you specify ORGANIZATION
, you must specify which organizational units the workspace can access in the workspaceOrganizationalUnits
parameter.
Sourcepub fn client_token(self, input: impl Into<String>) -> Self
pub fn client_token(self, input: impl Into<String>) -> Self
A unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
Sourcepub fn set_client_token(self, input: Option<String>) -> Self
pub fn set_client_token(self, input: Option<String>) -> Self
A unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
Sourcepub fn get_client_token(&self) -> &Option<String>
pub fn get_client_token(&self) -> &Option<String>
A unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
Sourcepub fn organization_role_name(self, input: impl Into<String>) -> Self
pub fn organization_role_name(self, input: impl Into<String>) -> Self
The name of an IAM role that already exists to use with Organizations to access Amazon Web Services data sources and notification channels in other accounts in an organization.
Sourcepub fn set_organization_role_name(self, input: Option<String>) -> Self
pub fn set_organization_role_name(self, input: Option<String>) -> Self
The name of an IAM role that already exists to use with Organizations to access Amazon Web Services data sources and notification channels in other accounts in an organization.
Sourcepub fn get_organization_role_name(&self) -> &Option<String>
pub fn get_organization_role_name(&self) -> &Option<String>
The name of an IAM role that already exists to use with Organizations to access Amazon Web Services data sources and notification channels in other accounts in an organization.
Sourcepub fn permission_type(self, input: PermissionType) -> Self
pub fn permission_type(self, input: PermissionType) -> Self
When creating a workspace through the Amazon Web Services API, CLI or Amazon Web Services CloudFormation, you must manage IAM roles and provision the permissions that the workspace needs to use Amazon Web Services data sources and notification channels.
You must also specify a workspaceRoleArn
for a role that you will manage for the workspace to use when accessing those datasources and notification channels.
The ability for Amazon Managed Grafana to create and update IAM roles on behalf of the user is supported only in the Amazon Managed Grafana console, where this value may be set to SERVICE_MANAGED
.
Use only the CUSTOMER_MANAGED
permission type when creating a workspace with the API, CLI or Amazon Web Services CloudFormation.
For more information, see Amazon Managed Grafana permissions and policies for Amazon Web Services data sources and notification channels.
Sourcepub fn set_permission_type(self, input: Option<PermissionType>) -> Self
pub fn set_permission_type(self, input: Option<PermissionType>) -> Self
When creating a workspace through the Amazon Web Services API, CLI or Amazon Web Services CloudFormation, you must manage IAM roles and provision the permissions that the workspace needs to use Amazon Web Services data sources and notification channels.
You must also specify a workspaceRoleArn
for a role that you will manage for the workspace to use when accessing those datasources and notification channels.
The ability for Amazon Managed Grafana to create and update IAM roles on behalf of the user is supported only in the Amazon Managed Grafana console, where this value may be set to SERVICE_MANAGED
.
Use only the CUSTOMER_MANAGED
permission type when creating a workspace with the API, CLI or Amazon Web Services CloudFormation.
For more information, see Amazon Managed Grafana permissions and policies for Amazon Web Services data sources and notification channels.
Sourcepub fn get_permission_type(&self) -> &Option<PermissionType>
pub fn get_permission_type(&self) -> &Option<PermissionType>
When creating a workspace through the Amazon Web Services API, CLI or Amazon Web Services CloudFormation, you must manage IAM roles and provision the permissions that the workspace needs to use Amazon Web Services data sources and notification channels.
You must also specify a workspaceRoleArn
for a role that you will manage for the workspace to use when accessing those datasources and notification channels.
The ability for Amazon Managed Grafana to create and update IAM roles on behalf of the user is supported only in the Amazon Managed Grafana console, where this value may be set to SERVICE_MANAGED
.
Use only the CUSTOMER_MANAGED
permission type when creating a workspace with the API, CLI or Amazon Web Services CloudFormation.
For more information, see Amazon Managed Grafana permissions and policies for Amazon Web Services data sources and notification channels.
Sourcepub fn stack_set_name(self, input: impl Into<String>) -> Self
pub fn stack_set_name(self, input: impl Into<String>) -> Self
The name of the CloudFormation stack set to use to generate IAM roles to be used for this workspace.
Sourcepub fn set_stack_set_name(self, input: Option<String>) -> Self
pub fn set_stack_set_name(self, input: Option<String>) -> Self
The name of the CloudFormation stack set to use to generate IAM roles to be used for this workspace.
Sourcepub fn get_stack_set_name(&self) -> &Option<String>
pub fn get_stack_set_name(&self) -> &Option<String>
The name of the CloudFormation stack set to use to generate IAM roles to be used for this workspace.
Sourcepub fn workspace_data_sources(self, input: DataSourceType) -> Self
pub fn workspace_data_sources(self, input: DataSourceType) -> Self
Appends an item to workspaceDataSources
.
To override the contents of this collection use set_workspace_data_sources
.
This parameter is for internal use only, and should not be used.
Sourcepub fn set_workspace_data_sources(
self,
input: Option<Vec<DataSourceType>>,
) -> Self
pub fn set_workspace_data_sources( self, input: Option<Vec<DataSourceType>>, ) -> Self
This parameter is for internal use only, and should not be used.
Sourcepub fn get_workspace_data_sources(&self) -> &Option<Vec<DataSourceType>>
pub fn get_workspace_data_sources(&self) -> &Option<Vec<DataSourceType>>
This parameter is for internal use only, and should not be used.
Sourcepub fn workspace_description(self, input: impl Into<String>) -> Self
pub fn workspace_description(self, input: impl Into<String>) -> Self
A description for the workspace. This is used only to help you identify this workspace.
Pattern: ^\[\\p{L}\\p{Z}\\p{N}\\p{P}\]{0,2048}$
Sourcepub fn set_workspace_description(self, input: Option<String>) -> Self
pub fn set_workspace_description(self, input: Option<String>) -> Self
A description for the workspace. This is used only to help you identify this workspace.
Pattern: ^\[\\p{L}\\p{Z}\\p{N}\\p{P}\]{0,2048}$
Sourcepub fn get_workspace_description(&self) -> &Option<String>
pub fn get_workspace_description(&self) -> &Option<String>
A description for the workspace. This is used only to help you identify this workspace.
Pattern: ^\[\\p{L}\\p{Z}\\p{N}\\p{P}\]{0,2048}$
Sourcepub fn workspace_name(self, input: impl Into<String>) -> Self
pub fn workspace_name(self, input: impl Into<String>) -> Self
The name for the workspace. It does not have to be unique.
Sourcepub fn set_workspace_name(self, input: Option<String>) -> Self
pub fn set_workspace_name(self, input: Option<String>) -> Self
The name for the workspace. It does not have to be unique.
Sourcepub fn get_workspace_name(&self) -> &Option<String>
pub fn get_workspace_name(&self) -> &Option<String>
The name for the workspace. It does not have to be unique.
Sourcepub fn workspace_notification_destinations(
self,
input: NotificationDestinationType,
) -> Self
pub fn workspace_notification_destinations( self, input: NotificationDestinationType, ) -> Self
Appends an item to workspaceNotificationDestinations
.
To override the contents of this collection use set_workspace_notification_destinations
.
Specify the Amazon Web Services notification channels that you plan to use in this workspace. Specifying these data sources here enables Amazon Managed Grafana to create IAM roles and permissions that allow Amazon Managed Grafana to use these channels.
Sourcepub fn set_workspace_notification_destinations(
self,
input: Option<Vec<NotificationDestinationType>>,
) -> Self
pub fn set_workspace_notification_destinations( self, input: Option<Vec<NotificationDestinationType>>, ) -> Self
Specify the Amazon Web Services notification channels that you plan to use in this workspace. Specifying these data sources here enables Amazon Managed Grafana to create IAM roles and permissions that allow Amazon Managed Grafana to use these channels.
Sourcepub fn get_workspace_notification_destinations(
&self,
) -> &Option<Vec<NotificationDestinationType>>
pub fn get_workspace_notification_destinations( &self, ) -> &Option<Vec<NotificationDestinationType>>
Specify the Amazon Web Services notification channels that you plan to use in this workspace. Specifying these data sources here enables Amazon Managed Grafana to create IAM roles and permissions that allow Amazon Managed Grafana to use these channels.
Sourcepub fn workspace_organizational_units(self, input: impl Into<String>) -> Self
pub fn workspace_organizational_units(self, input: impl Into<String>) -> Self
Appends an item to workspaceOrganizationalUnits
.
To override the contents of this collection use set_workspace_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.
Sourcepub fn set_workspace_organizational_units(
self,
input: Option<Vec<String>>,
) -> Self
pub fn set_workspace_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.
Sourcepub fn get_workspace_organizational_units(&self) -> &Option<Vec<String>>
pub fn get_workspace_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.
Sourcepub fn workspace_role_arn(self, input: impl Into<String>) -> Self
pub fn workspace_role_arn(self, input: impl Into<String>) -> Self
Specified the IAM role that grants permissions to the Amazon Web Services resources that the workspace will view data from, including both data sources and notification channels. You are responsible for managing the permissions for this role as new data sources or notification channels are added.
Sourcepub fn set_workspace_role_arn(self, input: Option<String>) -> Self
pub fn set_workspace_role_arn(self, input: Option<String>) -> Self
Specified the IAM role that grants permissions to the Amazon Web Services resources that the workspace will view data from, including both data sources and notification channels. You are responsible for managing the permissions for this role as new data sources or notification channels are added.
Sourcepub fn get_workspace_role_arn(&self) -> &Option<String>
pub fn get_workspace_role_arn(&self) -> &Option<String>
Specified the IAM role that grants permissions to the Amazon Web Services resources that the workspace will view data from, including both data sources and notification channels. You are responsible for managing the permissions for this role as new data sources or notification channels are added.
Sourcepub fn authentication_providers(
self,
input: AuthenticationProviderTypes,
) -> Self
pub fn authentication_providers( self, input: AuthenticationProviderTypes, ) -> Self
Appends an item to authenticationProviders
.
To override the contents of this collection use set_authentication_providers
.
Specifies whether this workspace uses SAML 2.0, IAM Identity Center, or both to authenticate users for using the Grafana console within a workspace. For more information, see User authentication in Amazon Managed Grafana.
Sourcepub fn set_authentication_providers(
self,
input: Option<Vec<AuthenticationProviderTypes>>,
) -> Self
pub fn set_authentication_providers( self, input: Option<Vec<AuthenticationProviderTypes>>, ) -> Self
Specifies whether this workspace uses SAML 2.0, IAM Identity Center, or both to authenticate users for using the Grafana console within a workspace. For more information, see User authentication in Amazon Managed Grafana.
Sourcepub fn get_authentication_providers(
&self,
) -> &Option<Vec<AuthenticationProviderTypes>>
pub fn get_authentication_providers( &self, ) -> &Option<Vec<AuthenticationProviderTypes>>
Specifies whether this workspace uses SAML 2.0, IAM Identity Center, or both to authenticate users for using the Grafana console within a workspace. For more information, see User authentication in Amazon Managed Grafana.
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.
The list of tags associated with the workspace.
The list of tags associated with the workspace.
Sourcepub fn vpc_configuration(self, input: VpcConfiguration) -> Self
pub fn vpc_configuration(self, input: VpcConfiguration) -> Self
The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to.
Connecting to a private VPC is not yet available in the Asia Pacific (Seoul) Region (ap-northeast-2).
Sourcepub fn set_vpc_configuration(self, input: Option<VpcConfiguration>) -> Self
pub fn set_vpc_configuration(self, input: Option<VpcConfiguration>) -> Self
The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to.
Connecting to a private VPC is not yet available in the Asia Pacific (Seoul) Region (ap-northeast-2).
Sourcepub fn get_vpc_configuration(&self) -> &Option<VpcConfiguration>
pub fn get_vpc_configuration(&self) -> &Option<VpcConfiguration>
The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to.
Connecting to a private VPC is not yet available in the Asia Pacific (Seoul) Region (ap-northeast-2).
Sourcepub fn configuration(self, input: impl Into<String>) -> Self
pub fn configuration(self, input: impl Into<String>) -> Self
The configuration string for the workspace that you create. For more information about the format and configuration options available, see Working in your Grafana workspace.
Sourcepub fn set_configuration(self, input: Option<String>) -> Self
pub fn set_configuration(self, input: Option<String>) -> Self
The configuration string for the workspace that you create. For more information about the format and configuration options available, see Working in your Grafana workspace.
Sourcepub fn get_configuration(&self) -> &Option<String>
pub fn get_configuration(&self) -> &Option<String>
The configuration string for the workspace that you create. For more information about the format and configuration options available, see Working in your Grafana workspace.
Sourcepub fn network_access_control(self, input: NetworkAccessConfiguration) -> Self
pub fn network_access_control(self, input: NetworkAccessConfiguration) -> Self
Configuration for network access to your workspace.
When this is configured, only listed IP addresses and VPC endpoints will be able to access your workspace. Standard Grafana authentication and authorization will still be required.
If this is not configured, or is removed, then all IP addresses and VPC endpoints will be allowed. Standard Grafana authentication and authorization will still be required.
Sourcepub fn set_network_access_control(
self,
input: Option<NetworkAccessConfiguration>,
) -> Self
pub fn set_network_access_control( self, input: Option<NetworkAccessConfiguration>, ) -> Self
Configuration for network access to your workspace.
When this is configured, only listed IP addresses and VPC endpoints will be able to access your workspace. Standard Grafana authentication and authorization will still be required.
If this is not configured, or is removed, then all IP addresses and VPC endpoints will be allowed. Standard Grafana authentication and authorization will still be required.
Sourcepub fn get_network_access_control(&self) -> &Option<NetworkAccessConfiguration>
pub fn get_network_access_control(&self) -> &Option<NetworkAccessConfiguration>
Configuration for network access to your workspace.
When this is configured, only listed IP addresses and VPC endpoints will be able to access your workspace. Standard Grafana authentication and authorization will still be required.
If this is not configured, or is removed, then all IP addresses and VPC endpoints will be allowed. Standard Grafana authentication and authorization will still be required.
Sourcepub fn grafana_version(self, input: impl Into<String>) -> Self
pub fn grafana_version(self, input: impl Into<String>) -> Self
Specifies the version of Grafana to support in the new workspace. If not specified, defaults to the latest version (for example, 10.4).
To get a list of supported versions, use the ListVersions
operation.
Sourcepub fn set_grafana_version(self, input: Option<String>) -> Self
pub fn set_grafana_version(self, input: Option<String>) -> Self
Specifies the version of Grafana to support in the new workspace. If not specified, defaults to the latest version (for example, 10.4).
To get a list of supported versions, use the ListVersions
operation.
Sourcepub fn get_grafana_version(&self) -> &Option<String>
pub fn get_grafana_version(&self) -> &Option<String>
Specifies the version of Grafana to support in the new workspace. If not specified, defaults to the latest version (for example, 10.4).
To get a list of supported versions, use the ListVersions
operation.
Trait Implementations§
Source§impl Clone for CreateWorkspaceFluentBuilder
impl Clone for CreateWorkspaceFluentBuilder
Source§fn clone(&self) -> CreateWorkspaceFluentBuilder
fn clone(&self) -> CreateWorkspaceFluentBuilder
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl Freeze for CreateWorkspaceFluentBuilder
impl !RefUnwindSafe for CreateWorkspaceFluentBuilder
impl Send for CreateWorkspaceFluentBuilder
impl Sync for CreateWorkspaceFluentBuilder
impl Unpin for CreateWorkspaceFluentBuilder
impl !UnwindSafe for CreateWorkspaceFluentBuilder
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);