#[non_exhaustive]pub struct CreateFileSystemLustreConfiguration {Show 18 fields
pub weekly_maintenance_start_time: Option<String>,
pub import_path: Option<String>,
pub export_path: Option<String>,
pub imported_file_chunk_size: Option<i32>,
pub deployment_type: Option<LustreDeploymentType>,
pub auto_import_policy: Option<AutoImportPolicyType>,
pub per_unit_storage_throughput: Option<i32>,
pub daily_automatic_backup_start_time: Option<String>,
pub automatic_backup_retention_days: Option<i32>,
pub copy_tags_to_backups: Option<bool>,
pub drive_cache_type: Option<DriveCacheType>,
pub data_compression_type: Option<DataCompressionType>,
pub efa_enabled: Option<bool>,
pub log_configuration: Option<LustreLogCreateConfiguration>,
pub root_squash_configuration: Option<LustreRootSquashConfiguration>,
pub metadata_configuration: Option<CreateFileSystemLustreMetadataConfiguration>,
pub throughput_capacity: Option<i32>,
pub data_read_cache_configuration: Option<LustreReadCacheConfiguration>,
}
Expand description
The Lustre configuration for the file system being created.
The following parameters are not supported for file systems with a data repository association created with .
-
AutoImportPolicy
-
ExportPath
-
ImportedFileChunkSize
-
ImportPath
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.weekly_maintenance_start_time: Option<String>
(Optional) The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone, where d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.
import_path: Option<String>
(Optional) The path to the Amazon S3 bucket (including the optional prefix) that you're using as the data repository for your Amazon FSx for Lustre file system. The root of your FSx for Lustre file system will be mapped to the root of the Amazon S3 bucket you select. An example is s3://import-bucket/optional-prefix
. If you specify a prefix after the Amazon S3 bucket name, only object keys with that prefix are loaded into the file system.
This parameter is not supported for file systems with a data repository association.
export_path: Option<String>
(Optional) Specifies the path in the Amazon S3 bucket where the root of your Amazon FSx file system is exported. The path must use the same Amazon S3 bucket as specified in ImportPath. You can provide an optional prefix to which new and changed data is to be exported from your Amazon FSx for Lustre file system. If an ExportPath
value is not provided, Amazon FSx sets a default export path, s3://import-bucket/FSxLustre\[creation-timestamp\]
. The timestamp is in UTC format, for example s3://import-bucket/FSxLustre20181105T222312Z
.
The Amazon S3 export bucket must be the same as the import bucket specified by ImportPath
. If you specify only a bucket name, such as s3://import-bucket
, you get a 1:1 mapping of file system objects to S3 bucket objects. This mapping means that the input data in S3 is overwritten on export. If you provide a custom prefix in the export path, such as s3://import-bucket/\[custom-optional-prefix\]
, Amazon FSx exports the contents of your file system to that export prefix in the Amazon S3 bucket.
This parameter is not supported for file systems with a data repository association.
imported_file_chunk_size: Option<i32>
(Optional) For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system.
The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB.
This parameter is not supported for file systems with a data repository association.
deployment_type: Option<LustreDeploymentType>
(Optional) Choose SCRATCH_1
and SCRATCH_2
deployment types when you need temporary storage and shorter-term processing of data. The SCRATCH_2
deployment type provides in-transit encryption of data and higher burst throughput capacity than SCRATCH_1
.
Choose PERSISTENT_1
for longer-term storage and for throughput-focused workloads that aren’t latency-sensitive. PERSISTENT_1
supports encryption of data in transit, and is available in all Amazon Web Services Regions in which FSx for Lustre is available.
Choose PERSISTENT_2
for longer-term storage and for latency-sensitive workloads that require the highest levels of IOPS/throughput. PERSISTENT_2
supports the SSD and Intelligent-Tiering storage classes. You can optionally specify a metadata configuration mode for PERSISTENT_2
which supports increasing metadata performance. PERSISTENT_2
is available in a limited number of Amazon Web Services Regions. For more information, and an up-to-date list of Amazon Web Services Regions in which PERSISTENT_2
is available, see Deployment and storage class options for FSx for Lustre file systems in the Amazon FSx for Lustre User Guide.
If you choose PERSISTENT_2
, and you set FileSystemTypeVersion
to 2.10
, the CreateFileSystem
operation fails.
Encryption of data in transit is automatically turned on when you access SCRATCH_2
, PERSISTENT_1
, and PERSISTENT_2
file systems from Amazon EC2 instances that support automatic encryption in the Amazon Web Services Regions where they are available. For more information about encryption in transit for FSx for Lustre file systems, see Encrypting data in transit in the Amazon FSx for Lustre User Guide.
(Default = SCRATCH_1
)
auto_import_policy: Option<AutoImportPolicyType>
(Optional) When you create your file system, your existing S3 objects appear as file and directory listings. Use this parameter to choose how Amazon FSx keeps your file and directory listings up to date as you add or modify objects in your linked S3 bucket. AutoImportPolicy
can have the following values:
-
NONE
- (Default) AutoImport is off. Amazon FSx only updates file and directory listings from the linked S3 bucket when the file system is created. FSx does not update file and directory listings for any new or changed objects after choosing this option. -
NEW
- AutoImport is on. Amazon FSx automatically imports directory listings of any new objects added to the linked S3 bucket that do not currently exist in the FSx file system. -
NEW_CHANGED
- AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket and any existing objects that are changed in the S3 bucket after you choose this option. -
NEW_CHANGED_DELETED
- AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket, any existing objects that are changed in the S3 bucket, and any objects that were deleted in the S3 bucket.
For more information, see Automatically import updates from your S3 bucket.
This parameter is not supported for file systems with a data repository association.
per_unit_storage_throughput: Option<i32>
Required with PERSISTENT_1
and PERSISTENT_2
deployment types using an SSD or HDD storage class, provisions the amount of read and write throughput for each 1 tebibyte (TiB) of file system storage capacity, in MB/s/TiB. File system throughput capacity is calculated by multiplying file system storage capacity (TiB) by the PerUnitStorageThroughput
(MB/s/TiB). For a 2.4-TiB file system, provisioning 50 MB/s/TiB of PerUnitStorageThroughput
yields 120 MB/s of file system throughput. You pay for the amount of throughput that you provision.
Valid values:
-
For
PERSISTENT_1
SSD storage: 50, 100, 200 MB/s/TiB. -
For
PERSISTENT_1
HDD storage: 12, 40 MB/s/TiB. -
For
PERSISTENT_2
SSD storage: 125, 250, 500, 1000 MB/s/TiB.
daily_automatic_backup_start_time: Option<String>
A recurring daily time, in the format HH:MM
. HH
is the zero-padded hour of the day (0-23), and MM
is the zero-padded minute of the hour. For example, 05:00
specifies 5 AM daily.
automatic_backup_retention_days: Option<i32>
The number of days to retain automatic backups. Setting this property to 0
disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is 0
.
(Optional) Not available for use with file systems that are linked to a data repository. A boolean flag indicating whether tags for the file system should be copied to backups. The default value is false. If CopyTagsToBackups
is set to true, all file system tags are copied to all automatic and user-initiated backups when the user doesn't specify any backup-specific tags. If CopyTagsToBackups
is set to true and you specify one or more backup tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value.
(Default = false
)
For more information, see Working with backups in the Amazon FSx for Lustre User Guide.
drive_cache_type: Option<DriveCacheType>
The type of drive cache used by PERSISTENT_1
file systems that are provisioned with HDD storage devices. This parameter is required when storage type is HDD. Set this property to READ
to improve the performance for frequently accessed files by caching up to 20% of the total storage capacity of the file system.
This parameter is required when StorageType
is set to HDD
.
data_compression_type: Option<DataCompressionType>
Sets the data compression configuration for the file system. DataCompressionType
can have the following values:
-
NONE
- (Default) Data compression is turned off when the file system is created. -
LZ4
- Data compression is turned on with the LZ4 algorithm.
For more information, see Lustre data compression in the Amazon FSx for Lustre User Guide.
efa_enabled: Option<bool>
(Optional) Specifies whether Elastic Fabric Adapter (EFA) and GPUDirect Storage (GDS) support is enabled for the Amazon FSx for Lustre file system.
(Default = false
)
log_configuration: Option<LustreLogCreateConfiguration>
The Lustre logging configuration used when creating an Amazon FSx for Lustre file system. When logging is enabled, Lustre logs error and warning events for data repositories associated with your file system to Amazon CloudWatch Logs.
root_squash_configuration: Option<LustreRootSquashConfiguration>
The Lustre root squash configuration used when creating an Amazon FSx for Lustre file system. When enabled, root squash restricts root-level access from clients that try to access your file system as a root user.
metadata_configuration: Option<CreateFileSystemLustreMetadataConfiguration>
The Lustre metadata performance configuration for the creation of an FSx for Lustre file system using a PERSISTENT_2
deployment type.
throughput_capacity: Option<i32>
Specifies the throughput of an FSx for Lustre file system using the Intelligent-Tiering storage class, measured in megabytes per second (MBps). Valid values are 4000 MBps or multiples of 4000 MBps. You pay for the amount of throughput that you provision.
data_read_cache_configuration: Option<LustreReadCacheConfiguration>
Specifies the optional provisioned SSD read cache on FSx for Lustre file systems that use the Intelligent-Tiering storage class. Required when StorageType
is set to INTELLIGENT_TIERING
.
Implementations§
Source§impl CreateFileSystemLustreConfiguration
impl CreateFileSystemLustreConfiguration
Sourcepub fn weekly_maintenance_start_time(&self) -> Option<&str>
pub fn weekly_maintenance_start_time(&self) -> Option<&str>
(Optional) The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone, where d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.
Sourcepub fn import_path(&self) -> Option<&str>
pub fn import_path(&self) -> Option<&str>
(Optional) The path to the Amazon S3 bucket (including the optional prefix) that you're using as the data repository for your Amazon FSx for Lustre file system. The root of your FSx for Lustre file system will be mapped to the root of the Amazon S3 bucket you select. An example is s3://import-bucket/optional-prefix
. If you specify a prefix after the Amazon S3 bucket name, only object keys with that prefix are loaded into the file system.
This parameter is not supported for file systems with a data repository association.
Sourcepub fn export_path(&self) -> Option<&str>
pub fn export_path(&self) -> Option<&str>
(Optional) Specifies the path in the Amazon S3 bucket where the root of your Amazon FSx file system is exported. The path must use the same Amazon S3 bucket as specified in ImportPath. You can provide an optional prefix to which new and changed data is to be exported from your Amazon FSx for Lustre file system. If an ExportPath
value is not provided, Amazon FSx sets a default export path, s3://import-bucket/FSxLustre\[creation-timestamp\]
. The timestamp is in UTC format, for example s3://import-bucket/FSxLustre20181105T222312Z
.
The Amazon S3 export bucket must be the same as the import bucket specified by ImportPath
. If you specify only a bucket name, such as s3://import-bucket
, you get a 1:1 mapping of file system objects to S3 bucket objects. This mapping means that the input data in S3 is overwritten on export. If you provide a custom prefix in the export path, such as s3://import-bucket/\[custom-optional-prefix\]
, Amazon FSx exports the contents of your file system to that export prefix in the Amazon S3 bucket.
This parameter is not supported for file systems with a data repository association.
Sourcepub fn imported_file_chunk_size(&self) -> Option<i32>
pub fn imported_file_chunk_size(&self) -> Option<i32>
(Optional) For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system.
The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB.
This parameter is not supported for file systems with a data repository association.
Sourcepub fn deployment_type(&self) -> Option<&LustreDeploymentType>
pub fn deployment_type(&self) -> Option<&LustreDeploymentType>
(Optional) Choose SCRATCH_1
and SCRATCH_2
deployment types when you need temporary storage and shorter-term processing of data. The SCRATCH_2
deployment type provides in-transit encryption of data and higher burst throughput capacity than SCRATCH_1
.
Choose PERSISTENT_1
for longer-term storage and for throughput-focused workloads that aren’t latency-sensitive. PERSISTENT_1
supports encryption of data in transit, and is available in all Amazon Web Services Regions in which FSx for Lustre is available.
Choose PERSISTENT_2
for longer-term storage and for latency-sensitive workloads that require the highest levels of IOPS/throughput. PERSISTENT_2
supports the SSD and Intelligent-Tiering storage classes. You can optionally specify a metadata configuration mode for PERSISTENT_2
which supports increasing metadata performance. PERSISTENT_2
is available in a limited number of Amazon Web Services Regions. For more information, and an up-to-date list of Amazon Web Services Regions in which PERSISTENT_2
is available, see Deployment and storage class options for FSx for Lustre file systems in the Amazon FSx for Lustre User Guide.
If you choose PERSISTENT_2
, and you set FileSystemTypeVersion
to 2.10
, the CreateFileSystem
operation fails.
Encryption of data in transit is automatically turned on when you access SCRATCH_2
, PERSISTENT_1
, and PERSISTENT_2
file systems from Amazon EC2 instances that support automatic encryption in the Amazon Web Services Regions where they are available. For more information about encryption in transit for FSx for Lustre file systems, see Encrypting data in transit in the Amazon FSx for Lustre User Guide.
(Default = SCRATCH_1
)
Sourcepub fn auto_import_policy(&self) -> Option<&AutoImportPolicyType>
pub fn auto_import_policy(&self) -> Option<&AutoImportPolicyType>
(Optional) When you create your file system, your existing S3 objects appear as file and directory listings. Use this parameter to choose how Amazon FSx keeps your file and directory listings up to date as you add or modify objects in your linked S3 bucket. AutoImportPolicy
can have the following values:
-
NONE
- (Default) AutoImport is off. Amazon FSx only updates file and directory listings from the linked S3 bucket when the file system is created. FSx does not update file and directory listings for any new or changed objects after choosing this option. -
NEW
- AutoImport is on. Amazon FSx automatically imports directory listings of any new objects added to the linked S3 bucket that do not currently exist in the FSx file system. -
NEW_CHANGED
- AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket and any existing objects that are changed in the S3 bucket after you choose this option. -
NEW_CHANGED_DELETED
- AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket, any existing objects that are changed in the S3 bucket, and any objects that were deleted in the S3 bucket.
For more information, see Automatically import updates from your S3 bucket.
This parameter is not supported for file systems with a data repository association.
Sourcepub fn per_unit_storage_throughput(&self) -> Option<i32>
pub fn per_unit_storage_throughput(&self) -> Option<i32>
Required with PERSISTENT_1
and PERSISTENT_2
deployment types using an SSD or HDD storage class, provisions the amount of read and write throughput for each 1 tebibyte (TiB) of file system storage capacity, in MB/s/TiB. File system throughput capacity is calculated by multiplying file system storage capacity (TiB) by the PerUnitStorageThroughput
(MB/s/TiB). For a 2.4-TiB file system, provisioning 50 MB/s/TiB of PerUnitStorageThroughput
yields 120 MB/s of file system throughput. You pay for the amount of throughput that you provision.
Valid values:
-
For
PERSISTENT_1
SSD storage: 50, 100, 200 MB/s/TiB. -
For
PERSISTENT_1
HDD storage: 12, 40 MB/s/TiB. -
For
PERSISTENT_2
SSD storage: 125, 250, 500, 1000 MB/s/TiB.
Sourcepub fn daily_automatic_backup_start_time(&self) -> Option<&str>
pub fn daily_automatic_backup_start_time(&self) -> Option<&str>
A recurring daily time, in the format HH:MM
. HH
is the zero-padded hour of the day (0-23), and MM
is the zero-padded minute of the hour. For example, 05:00
specifies 5 AM daily.
Sourcepub fn automatic_backup_retention_days(&self) -> Option<i32>
pub fn automatic_backup_retention_days(&self) -> Option<i32>
The number of days to retain automatic backups. Setting this property to 0
disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is 0
.
(Optional) Not available for use with file systems that are linked to a data repository. A boolean flag indicating whether tags for the file system should be copied to backups. The default value is false. If CopyTagsToBackups
is set to true, all file system tags are copied to all automatic and user-initiated backups when the user doesn't specify any backup-specific tags. If CopyTagsToBackups
is set to true and you specify one or more backup tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value.
(Default = false
)
For more information, see Working with backups in the Amazon FSx for Lustre User Guide.
Sourcepub fn drive_cache_type(&self) -> Option<&DriveCacheType>
pub fn drive_cache_type(&self) -> Option<&DriveCacheType>
The type of drive cache used by PERSISTENT_1
file systems that are provisioned with HDD storage devices. This parameter is required when storage type is HDD. Set this property to READ
to improve the performance for frequently accessed files by caching up to 20% of the total storage capacity of the file system.
This parameter is required when StorageType
is set to HDD
.
Sourcepub fn data_compression_type(&self) -> Option<&DataCompressionType>
pub fn data_compression_type(&self) -> Option<&DataCompressionType>
Sets the data compression configuration for the file system. DataCompressionType
can have the following values:
-
NONE
- (Default) Data compression is turned off when the file system is created. -
LZ4
- Data compression is turned on with the LZ4 algorithm.
For more information, see Lustre data compression in the Amazon FSx for Lustre User Guide.
Sourcepub fn efa_enabled(&self) -> Option<bool>
pub fn efa_enabled(&self) -> Option<bool>
(Optional) Specifies whether Elastic Fabric Adapter (EFA) and GPUDirect Storage (GDS) support is enabled for the Amazon FSx for Lustre file system.
(Default = false
)
Sourcepub fn log_configuration(&self) -> Option<&LustreLogCreateConfiguration>
pub fn log_configuration(&self) -> Option<&LustreLogCreateConfiguration>
The Lustre logging configuration used when creating an Amazon FSx for Lustre file system. When logging is enabled, Lustre logs error and warning events for data repositories associated with your file system to Amazon CloudWatch Logs.
Sourcepub fn root_squash_configuration(
&self,
) -> Option<&LustreRootSquashConfiguration>
pub fn root_squash_configuration( &self, ) -> Option<&LustreRootSquashConfiguration>
The Lustre root squash configuration used when creating an Amazon FSx for Lustre file system. When enabled, root squash restricts root-level access from clients that try to access your file system as a root user.
Sourcepub fn metadata_configuration(
&self,
) -> Option<&CreateFileSystemLustreMetadataConfiguration>
pub fn metadata_configuration( &self, ) -> Option<&CreateFileSystemLustreMetadataConfiguration>
The Lustre metadata performance configuration for the creation of an FSx for Lustre file system using a PERSISTENT_2
deployment type.
Sourcepub fn throughput_capacity(&self) -> Option<i32>
pub fn throughput_capacity(&self) -> Option<i32>
Specifies the throughput of an FSx for Lustre file system using the Intelligent-Tiering storage class, measured in megabytes per second (MBps). Valid values are 4000 MBps or multiples of 4000 MBps. You pay for the amount of throughput that you provision.
Sourcepub fn data_read_cache_configuration(
&self,
) -> Option<&LustreReadCacheConfiguration>
pub fn data_read_cache_configuration( &self, ) -> Option<&LustreReadCacheConfiguration>
Specifies the optional provisioned SSD read cache on FSx for Lustre file systems that use the Intelligent-Tiering storage class. Required when StorageType
is set to INTELLIGENT_TIERING
.
Source§impl CreateFileSystemLustreConfiguration
impl CreateFileSystemLustreConfiguration
Sourcepub fn builder() -> CreateFileSystemLustreConfigurationBuilder
pub fn builder() -> CreateFileSystemLustreConfigurationBuilder
Creates a new builder-style object to manufacture CreateFileSystemLustreConfiguration
.
Trait Implementations§
Source§impl Clone for CreateFileSystemLustreConfiguration
impl Clone for CreateFileSystemLustreConfiguration
Source§fn clone(&self) -> CreateFileSystemLustreConfiguration
fn clone(&self) -> CreateFileSystemLustreConfiguration
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl PartialEq for CreateFileSystemLustreConfiguration
impl PartialEq for CreateFileSystemLustreConfiguration
Source§fn eq(&self, other: &CreateFileSystemLustreConfiguration) -> bool
fn eq(&self, other: &CreateFileSystemLustreConfiguration) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for CreateFileSystemLustreConfiguration
Auto Trait Implementations§
impl Freeze for CreateFileSystemLustreConfiguration
impl RefUnwindSafe for CreateFileSystemLustreConfiguration
impl Send for CreateFileSystemLustreConfiguration
impl Sync for CreateFileSystemLustreConfiguration
impl Unpin for CreateFileSystemLustreConfiguration
impl UnwindSafe for CreateFileSystemLustreConfiguration
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);