pub struct Client { /* private fields */ }Expand description
Client for Amazon S3 Tables
Client for invoking operations on Amazon S3 Tables. Each operation on Amazon S3 Tables is a method on this
this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.
§Constructing a Client
A Config is required to construct a client. For most use cases, the aws-config
crate should be used to automatically resolve this config using
aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared
across multiple different AWS SDK clients. This config resolution process can be customized
by calling aws_config::from_env() instead, which returns a ConfigLoader that uses
the builder pattern to customize the default config.
In the simplest case, creating a client looks as follows:
let config = aws_config::load_from_env().await;
let client = aws_sdk_s3tables::Client::new(&config);Occasionally, SDKs may have additional service-specific values that can be set on the Config that
is absent from SdkConfig, or slightly different settings for a specific client may be desired.
The Builder struct implements From<&SdkConfig>, so setting these specific settings can be
done as follows:
let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_s3tables::config::Builder::from(&sdk_config)
.some_service_specific_setting("value")
.build();See the aws-config docs and Config for more information on customizing configuration.
Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.
§Using the Client
A client has a function for every operation that can be performed by the service.
For example, the CreateNamespace operation has
a Client::create_namespace, function which returns a builder for that operation.
The fluent builder ultimately has a send() function that returns an async future that
returns a result, as illustrated below:
let result = client.create_namespace()
.table_bucket_arn("example")
.send()
.await;The underlying HTTP requests that get made by this can be modified with the customize_operation
function on the fluent builder. See the customize module for more
information.
Implementations§
Source§impl Client
impl Client
Sourcepub fn create_namespace(&self) -> CreateNamespaceFluentBuilder
pub fn create_namespace(&self) -> CreateNamespaceFluentBuilder
Constructs a fluent builder for the CreateNamespace operation.
- The fluent builder is configurable:
table_bucket_arn(impl Into<String>)/set_table_bucket_arn(Option<String>):
required: trueThe Amazon Resource Name (ARN) of the table bucket to create the namespace in.
namespace(impl Into<String>)/set_namespace(Option<Vec::<String>>):
required: trueA name for the namespace.
- On success, responds with
CreateNamespaceOutputwith field(s):table_bucket_arn(String):The Amazon Resource Name (ARN) of the table bucket the namespace was created in.
namespace(Vec::<String>):The name of the namespace.
- On failure, responds with
SdkError<CreateNamespaceError>
Source§impl Client
impl Client
Sourcepub fn create_table(&self) -> CreateTableFluentBuilder
pub fn create_table(&self) -> CreateTableFluentBuilder
Constructs a fluent builder for the CreateTable operation.
- The fluent builder is configurable:
table_bucket_arn(impl Into<String>)/set_table_bucket_arn(Option<String>):
required: trueThe Amazon Resource Name (ARN) of the table bucket to create the table in.
namespace(impl Into<String>)/set_namespace(Option<String>):
required: trueThe namespace to associated with the table.
name(impl Into<String>)/set_name(Option<String>):
required: trueThe name for the table.
format(OpenTableFormat)/set_format(Option<OpenTableFormat>):
required: trueThe format for the table.
metadata(TableMetadata)/set_metadata(Option<TableMetadata>):
required: falseThe metadata for the table.
encryption_configuration(EncryptionConfiguration)/set_encryption_configuration(Option<EncryptionConfiguration>):
required: falseThe encryption configuration to use for the table. This configuration specifies the encryption algorithm and, if using SSE-KMS, the KMS key to use for encrypting the table.
If you choose SSE-KMS encryption you must grant the S3 Tables maintenance principal access to your KMS key. For more information, see Permissions requirements for S3 Tables SSE-KMS encryption.
storage_class_configuration(StorageClassConfiguration)/set_storage_class_configuration(Option<StorageClassConfiguration>):
required: falseThe storage class configuration for the table. If not specified, the table inherits the storage class configuration from its table bucket. Specify this parameter to override the bucket’s default storage class for this table.
tags(impl Into<String>, impl Into<String>)/set_tags(Option<HashMap::<String, String>>):
required: falseA map of user-defined tags that you would like to apply to the table that you are creating. A tag is a key-value pair that you apply to your resources. Tags can help you organize, track costs for, and control access to resources. For more information, see Tagging for cost allocation or attribute-based access control (ABAC).
You must have the
s3tables:TagResourcepermission in addition tos3tables:CreateTablepermission to create a table with tags.
- On success, responds with
CreateTableOutputwith field(s):table_arn(String):The Amazon Resource Name (ARN) of the table.
version_token(String):The version token of the table.
- On failure, responds with
SdkError<CreateTableError>
Source§impl Client
impl Client
Sourcepub fn create_table_bucket(&self) -> CreateTableBucketFluentBuilder
pub fn create_table_bucket(&self) -> CreateTableBucketFluentBuilder
Constructs a fluent builder for the CreateTableBucket operation.
- The fluent builder is configurable:
name(impl Into<String>)/set_name(Option<String>):
required: trueThe name for the table bucket.
encryption_configuration(EncryptionConfiguration)/set_encryption_configuration(Option<EncryptionConfiguration>):
required: falseThe encryption configuration to use for the table bucket. This configuration specifies the default encryption settings that will be applied to all tables created in this bucket unless overridden at the table level. The configuration includes the encryption algorithm and, if using SSE-KMS, the KMS key to use.
storage_class_configuration(StorageClassConfiguration)/set_storage_class_configuration(Option<StorageClassConfiguration>):
required: falseThe default storage class configuration for the table bucket. This configuration will be applied to all new tables created in this bucket unless overridden at the table level. If not specified, the service default storage class will be used.
tags(impl Into<String>, impl Into<String>)/set_tags(Option<HashMap::<String, String>>):
required: falseA map of user-defined tags that you would like to apply to the table bucket that you are creating. A tag is a key-value pair that you apply to your resources. Tags can help you organize and control access to resources. For more information, see Tagging for cost allocation or attribute-based access control (ABAC).
You must have the
s3tables:TagResourcepermission in addition tos3tables:CreateTableBucketpermisson to create a table bucket with tags.
- On success, responds with
CreateTableBucketOutputwith field(s):arn(String):The Amazon Resource Name (ARN) of the table bucket.
- On failure, responds with
SdkError<CreateTableBucketError>
Source§impl Client
impl Client
Sourcepub fn delete_namespace(&self) -> DeleteNamespaceFluentBuilder
pub fn delete_namespace(&self) -> DeleteNamespaceFluentBuilder
Constructs a fluent builder for the DeleteNamespace operation.
- The fluent builder is configurable:
table_bucket_arn(impl Into<String>)/set_table_bucket_arn(Option<String>):
required: trueThe Amazon Resource Name (ARN) of the table bucket associated with the namespace.
namespace(impl Into<String>)/set_namespace(Option<String>):
required: trueThe name of the namespace.
- On success, responds with
DeleteNamespaceOutput - On failure, responds with
SdkError<DeleteNamespaceError>
Source§impl Client
impl Client
Sourcepub fn delete_table(&self) -> DeleteTableFluentBuilder
pub fn delete_table(&self) -> DeleteTableFluentBuilder
Constructs a fluent builder for the DeleteTable operation.
- The fluent builder is configurable:
table_bucket_arn(impl Into<String>)/set_table_bucket_arn(Option<String>):
required: trueThe Amazon Resource Name (ARN) of the table bucket that contains the table.
namespace(impl Into<String>)/set_namespace(Option<String>):
required: trueThe namespace associated with the table.
name(impl Into<String>)/set_name(Option<String>):
required: trueThe name of the table.
version_token(impl Into<String>)/set_version_token(Option<String>):
required: falseThe version token of the table.
- On success, responds with
DeleteTableOutput - On failure, responds with
SdkError<DeleteTableError>
Source§impl Client
impl Client
Sourcepub fn delete_table_bucket(&self) -> DeleteTableBucketFluentBuilder
pub fn delete_table_bucket(&self) -> DeleteTableBucketFluentBuilder
Constructs a fluent builder for the DeleteTableBucket operation.
- The fluent builder is configurable:
table_bucket_arn(impl Into<String>)/set_table_bucket_arn(Option<String>):
required: trueThe Amazon Resource Name (ARN) of the table bucket.
- On success, responds with
DeleteTableBucketOutput - On failure, responds with
SdkError<DeleteTableBucketError>
Source§impl Client
impl Client
Sourcepub fn delete_table_bucket_encryption(
&self,
) -> DeleteTableBucketEncryptionFluentBuilder
pub fn delete_table_bucket_encryption( &self, ) -> DeleteTableBucketEncryptionFluentBuilder
Constructs a fluent builder for the DeleteTableBucketEncryption operation.
- The fluent builder is configurable:
table_bucket_arn(impl Into<String>)/set_table_bucket_arn(Option<String>):
required: trueThe Amazon Resource Name (ARN) of the table bucket.
- On success, responds with
DeleteTableBucketEncryptionOutput - On failure, responds with
SdkError<DeleteTableBucketEncryptionError>
Source§impl Client
impl Client
Sourcepub fn delete_table_bucket_metrics_configuration(
&self,
) -> DeleteTableBucketMetricsConfigurationFluentBuilder
pub fn delete_table_bucket_metrics_configuration( &self, ) -> DeleteTableBucketMetricsConfigurationFluentBuilder
Constructs a fluent builder for the DeleteTableBucketMetricsConfiguration operation.
- The fluent builder is configurable:
table_bucket_arn(impl Into<String>)/set_table_bucket_arn(Option<String>):
required: trueThe Amazon Resource Name (ARN) of the table bucket.
- On success, responds with
DeleteTableBucketMetricsConfigurationOutput - On failure, responds with
SdkError<DeleteTableBucketMetricsConfigurationError>
Source§impl Client
impl Client
Sourcepub fn delete_table_bucket_policy(&self) -> DeleteTableBucketPolicyFluentBuilder
pub fn delete_table_bucket_policy(&self) -> DeleteTableBucketPolicyFluentBuilder
Constructs a fluent builder for the DeleteTableBucketPolicy operation.
- The fluent builder is configurable:
table_bucket_arn(impl Into<String>)/set_table_bucket_arn(Option<String>):
required: trueThe Amazon Resource Name (ARN) of the table bucket.
- On success, responds with
DeleteTableBucketPolicyOutput - On failure, responds with
SdkError<DeleteTableBucketPolicyError>
Source§impl Client
impl Client
Sourcepub fn delete_table_bucket_replication(
&self,
) -> DeleteTableBucketReplicationFluentBuilder
pub fn delete_table_bucket_replication( &self, ) -> DeleteTableBucketReplicationFluentBuilder
Constructs a fluent builder for the DeleteTableBucketReplication operation.
- The fluent builder is configurable:
table_bucket_arn(impl Into<String>)/set_table_bucket_arn(Option<String>):
required: trueThe Amazon Resource Name (ARN) of the table bucket.
version_token(impl Into<String>)/set_version_token(Option<String>):
required: falseA version token from a previous GetTableBucketReplication call. Use this token to ensure you’re deleting the expected version of the configuration.
- On success, responds with
DeleteTableBucketReplicationOutput - On failure, responds with
SdkError<DeleteTableBucketReplicationError>
Source§impl Client
impl Client
Sourcepub fn delete_table_policy(&self) -> DeleteTablePolicyFluentBuilder
pub fn delete_table_policy(&self) -> DeleteTablePolicyFluentBuilder
Constructs a fluent builder for the DeleteTablePolicy operation.
- The fluent builder is configurable:
table_bucket_arn(impl Into<String>)/set_table_bucket_arn(Option<String>):
required: trueThe Amazon Resource Name (ARN) of the table bucket that contains the table.
namespace(impl Into<String>)/set_namespace(Option<String>):
required: trueThe namespace associated with the table.
name(impl Into<String>)/set_name(Option<String>):
required: trueThe table name.
- On success, responds with
DeleteTablePolicyOutput - On failure, responds with
SdkError<DeleteTablePolicyError>
Source§impl Client
impl Client
Sourcepub fn delete_table_replication(&self) -> DeleteTableReplicationFluentBuilder
pub fn delete_table_replication(&self) -> DeleteTableReplicationFluentBuilder
Constructs a fluent builder for the DeleteTableReplication operation.
- The fluent builder is configurable:
table_arn(impl Into<String>)/set_table_arn(Option<String>):
required: trueThe Amazon Resource Name (ARN) of the table.
version_token(impl Into<String>)/set_version_token(Option<String>):
required: trueA version token from a previous GetTableReplication call. Use this token to ensure you’re deleting the expected version of the configuration.
- On success, responds with
DeleteTableReplicationOutput - On failure, responds with
SdkError<DeleteTableReplicationError>
Source§impl Client
impl Client
Sourcepub fn get_namespace(&self) -> GetNamespaceFluentBuilder
pub fn get_namespace(&self) -> GetNamespaceFluentBuilder
Constructs a fluent builder for the GetNamespace operation.
- The fluent builder is configurable:
table_bucket_arn(impl Into<String>)/set_table_bucket_arn(Option<String>):
required: trueThe Amazon Resource Name (ARN) of the table bucket.
namespace(impl Into<String>)/set_namespace(Option<String>):
required: trueThe name of the namespace.
- On success, responds with
GetNamespaceOutputwith field(s):namespace(Vec::<String>):The name of the namespace.
created_at(DateTime):The date and time the namespace was created at.
created_by(String):The ID of the account that created the namespace.
owner_account_id(String):The ID of the account that owns the namespcace.
namespace_id(Option<String>):The unique identifier of the namespace.
table_bucket_id(Option<String>):The unique identifier of the table bucket containing this namespace.
- On failure, responds with
SdkError<GetNamespaceError>
Source§impl Client
impl Client
Sourcepub fn get_table(&self) -> GetTableFluentBuilder
pub fn get_table(&self) -> GetTableFluentBuilder
Constructs a fluent builder for the GetTable operation.
- The fluent builder is configurable:
table_bucket_arn(impl Into<String>)/set_table_bucket_arn(Option<String>):
required: falseThe Amazon Resource Name (ARN) of the table bucket associated with the table.
namespace(impl Into<String>)/set_namespace(Option<String>):
required: falseThe name of the namespace the table is associated with.
name(impl Into<String>)/set_name(Option<String>):
required: falseThe name of the table.
table_arn(impl Into<String>)/set_table_arn(Option<String>):
required: falseThe Amazon Resource Name (ARN) of the table.
- On success, responds with
GetTableOutputwith field(s):name(String):The name of the table.
r#type(TableType):The type of the table.
table_arn(String):The Amazon Resource Name (ARN) of the table.
namespace(Vec::<String>):The namespace associated with the table.
namespace_id(Option<String>):The unique identifier of the namespace containing this table.
version_token(String):The version token of the table.
metadata_location(Option<String>):The metadata location of the table.
warehouse_location(String):The warehouse location of the table.
created_at(DateTime):The date and time the table bucket was created at.
created_by(String):The ID of the account that created the table.
managed_by_service(Option<String>):The service that manages the table.
modified_at(DateTime):The date and time the table was last modified on.
modified_by(String):The ID of the account that last modified the table.
owner_account_id(String):The ID of the account that owns the table.
format(OpenTableFormat):The format of the table.
table_bucket_id(Option<String>):The unique identifier of the table bucket containing this table.
managed_table_information(Option<ManagedTableInformation>):If this table is managed by S3 Tables, contains additional information such as replication details.
- On failure, responds with
SdkError<GetTableError>
Source§impl Client
impl Client
Sourcepub fn get_table_bucket(&self) -> GetTableBucketFluentBuilder
pub fn get_table_bucket(&self) -> GetTableBucketFluentBuilder
Constructs a fluent builder for the GetTableBucket operation.
- The fluent builder is configurable:
table_bucket_arn(impl Into<String>)/set_table_bucket_arn(Option<String>):
required: trueThe Amazon Resource Name (ARN) of the table bucket.
- On success, responds with
GetTableBucketOutputwith field(s):arn(String):The Amazon Resource Name (ARN) of the table bucket.
name(String):The name of the table bucket
owner_account_id(String):The ID of the account that owns the table bucket.
created_at(DateTime):The date and time the table bucket was created.
table_bucket_id(Option<String>):The unique identifier of the table bucket.
r#type(Option<TableBucketType>):The type of the table bucket.
- On failure, responds with
SdkError<GetTableBucketError>
Source§impl Client
impl Client
Sourcepub fn get_table_bucket_encryption(
&self,
) -> GetTableBucketEncryptionFluentBuilder
pub fn get_table_bucket_encryption( &self, ) -> GetTableBucketEncryptionFluentBuilder
Constructs a fluent builder for the GetTableBucketEncryption operation.
- The fluent builder is configurable:
table_bucket_arn(impl Into<String>)/set_table_bucket_arn(Option<String>):
required: trueThe Amazon Resource Name (ARN) of the table bucket.
- On success, responds with
GetTableBucketEncryptionOutputwith field(s):encryption_configuration(Option<EncryptionConfiguration>):The encryption configuration for the table bucket.
- On failure, responds with
SdkError<GetTableBucketEncryptionError>
Source§impl Client
impl Client
Sourcepub fn get_table_bucket_maintenance_configuration(
&self,
) -> GetTableBucketMaintenanceConfigurationFluentBuilder
pub fn get_table_bucket_maintenance_configuration( &self, ) -> GetTableBucketMaintenanceConfigurationFluentBuilder
Constructs a fluent builder for the GetTableBucketMaintenanceConfiguration operation.
- The fluent builder is configurable:
table_bucket_arn(impl Into<String>)/set_table_bucket_arn(Option<String>):
required: trueThe Amazon Resource Name (ARN) of the table bucket associated with the maintenance configuration.
- On success, responds with
GetTableBucketMaintenanceConfigurationOutputwith field(s):table_bucket_arn(String):The Amazon Resource Name (ARN) of the table bucket associated with the maintenance configuration.
configuration(HashMap::<TableBucketMaintenanceType, TableBucketMaintenanceConfigurationValue>):Details about the maintenance configuration for the table bucket.
- On failure, responds with
SdkError<GetTableBucketMaintenanceConfigurationError>
Source§impl Client
impl Client
Sourcepub fn get_table_bucket_metrics_configuration(
&self,
) -> GetTableBucketMetricsConfigurationFluentBuilder
pub fn get_table_bucket_metrics_configuration( &self, ) -> GetTableBucketMetricsConfigurationFluentBuilder
Constructs a fluent builder for the GetTableBucketMetricsConfiguration operation.
- The fluent builder is configurable:
table_bucket_arn(impl Into<String>)/set_table_bucket_arn(Option<String>):
required: trueThe Amazon Resource Name (ARN) of the table bucket.
- On success, responds with
GetTableBucketMetricsConfigurationOutputwith field(s):table_bucket_arn(String):The Amazon Resource Name (ARN) of the table bucket.
id(Option<String>):The unique identifier of the metrics configuration.
- On failure, responds with
SdkError<GetTableBucketMetricsConfigurationError>
Source§impl Client
impl Client
Sourcepub fn get_table_bucket_policy(&self) -> GetTableBucketPolicyFluentBuilder
pub fn get_table_bucket_policy(&self) -> GetTableBucketPolicyFluentBuilder
Constructs a fluent builder for the GetTableBucketPolicy operation.
- The fluent builder is configurable:
table_bucket_arn(impl Into<String>)/set_table_bucket_arn(Option<String>):
required: trueThe Amazon Resource Name (ARN) of the table bucket.
- On success, responds with
GetTableBucketPolicyOutputwith field(s):resource_policy(String):The
JSONthat defines the policy.
- On failure, responds with
SdkError<GetTableBucketPolicyError>
Source§impl Client
impl Client
Sourcepub fn get_table_bucket_replication(
&self,
) -> GetTableBucketReplicationFluentBuilder
pub fn get_table_bucket_replication( &self, ) -> GetTableBucketReplicationFluentBuilder
Constructs a fluent builder for the GetTableBucketReplication operation.
- The fluent builder is configurable:
table_bucket_arn(impl Into<String>)/set_table_bucket_arn(Option<String>):
required: trueThe Amazon Resource Name (ARN) of the table bucket.
- On success, responds with
GetTableBucketReplicationOutputwith field(s):version_token(String):A version token that represents the current state of the replication configuration. Use this token when updating the configuration to ensure consistency.
configuration(Option<TableBucketReplicationConfiguration>):The replication configuration for the table bucket, including the IAM role and replication rules.
- On failure, responds with
SdkError<GetTableBucketReplicationError>
Source§impl Client
impl Client
Sourcepub fn get_table_bucket_storage_class(
&self,
) -> GetTableBucketStorageClassFluentBuilder
pub fn get_table_bucket_storage_class( &self, ) -> GetTableBucketStorageClassFluentBuilder
Constructs a fluent builder for the GetTableBucketStorageClass operation.
- The fluent builder is configurable:
table_bucket_arn(impl Into<String>)/set_table_bucket_arn(Option<String>):
required: trueThe Amazon Resource Name (ARN) of the table bucket.
- On success, responds with
GetTableBucketStorageClassOutputwith field(s):storage_class_configuration(Option<StorageClassConfiguration>):The storage class configuration for the table bucket.
- On failure, responds with
SdkError<GetTableBucketStorageClassError>
Source§impl Client
impl Client
Sourcepub fn get_table_encryption(&self) -> GetTableEncryptionFluentBuilder
pub fn get_table_encryption(&self) -> GetTableEncryptionFluentBuilder
Constructs a fluent builder for the GetTableEncryption operation.
- The fluent builder is configurable:
table_bucket_arn(impl Into<String>)/set_table_bucket_arn(Option<String>):
required: trueThe Amazon Resource Name (ARN) of the table bucket containing the table.
namespace(impl Into<String>)/set_namespace(Option<String>):
required: trueThe namespace associated with the table.
name(impl Into<String>)/set_name(Option<String>):
required: trueThe name of the table.
- On success, responds with
GetTableEncryptionOutputwith field(s):encryption_configuration(Option<EncryptionConfiguration>):The encryption configuration for the table.
- On failure, responds with
SdkError<GetTableEncryptionError>
Source§impl Client
impl Client
Sourcepub fn get_table_maintenance_configuration(
&self,
) -> GetTableMaintenanceConfigurationFluentBuilder
pub fn get_table_maintenance_configuration( &self, ) -> GetTableMaintenanceConfigurationFluentBuilder
Constructs a fluent builder for the GetTableMaintenanceConfiguration operation.
- The fluent builder is configurable:
table_bucket_arn(impl Into<String>)/set_table_bucket_arn(Option<String>):
required: trueThe Amazon Resource Name (ARN) of the table bucket.
namespace(impl Into<String>)/set_namespace(Option<String>):
required: trueThe namespace associated with the table.
name(impl Into<String>)/set_name(Option<String>):
required: trueThe name of the table.
- On success, responds with
GetTableMaintenanceConfigurationOutputwith field(s):table_arn(String):The Amazon Resource Name (ARN) of the table.
configuration(HashMap::<TableMaintenanceType, TableMaintenanceConfigurationValue>):Details about the maintenance configuration for the table bucket.
- On failure, responds with
SdkError<GetTableMaintenanceConfigurationError>
Source§impl Client
impl Client
Sourcepub fn get_table_maintenance_job_status(
&self,
) -> GetTableMaintenanceJobStatusFluentBuilder
pub fn get_table_maintenance_job_status( &self, ) -> GetTableMaintenanceJobStatusFluentBuilder
Constructs a fluent builder for the GetTableMaintenanceJobStatus operation.
- The fluent builder is configurable:
table_bucket_arn(impl Into<String>)/set_table_bucket_arn(Option<String>):
required: trueThe Amazon Resource Name (ARN) of the table bucket.
namespace(impl Into<String>)/set_namespace(Option<String>):
required: trueThe name of the namespace the table is associated with.
name(impl Into<String>)/set_name(Option<String>):
required: trueThe name of the table containing the maintenance job status you want to check.
- On success, responds with
GetTableMaintenanceJobStatusOutputwith field(s):table_arn(String):The Amazon Resource Name (ARN) of the table.
status(HashMap::<TableMaintenanceJobType, TableMaintenanceJobStatusValue>):The status of the maintenance job.
- On failure, responds with
SdkError<GetTableMaintenanceJobStatusError>
Source§impl Client
impl Client
Sourcepub fn get_table_metadata_location(
&self,
) -> GetTableMetadataLocationFluentBuilder
pub fn get_table_metadata_location( &self, ) -> GetTableMetadataLocationFluentBuilder
Constructs a fluent builder for the GetTableMetadataLocation operation.
- The fluent builder is configurable:
table_bucket_arn(impl Into<String>)/set_table_bucket_arn(Option<String>):
required: trueThe Amazon Resource Name (ARN) of the table bucket.
namespace(impl Into<String>)/set_namespace(Option<String>):
required: trueThe namespace of the table.
name(impl Into<String>)/set_name(Option<String>):
required: trueThe name of the table.
- On success, responds with
GetTableMetadataLocationOutputwith field(s):version_token(String):The version token.
metadata_location(Option<String>):The metadata location.
warehouse_location(String):The warehouse location.
- On failure, responds with
SdkError<GetTableMetadataLocationError>
Source§impl Client
impl Client
Sourcepub fn get_table_policy(&self) -> GetTablePolicyFluentBuilder
pub fn get_table_policy(&self) -> GetTablePolicyFluentBuilder
Constructs a fluent builder for the GetTablePolicy operation.
- The fluent builder is configurable:
table_bucket_arn(impl Into<String>)/set_table_bucket_arn(Option<String>):
required: trueThe Amazon Resource Name (ARN) of the table bucket that contains the table.
namespace(impl Into<String>)/set_namespace(Option<String>):
required: trueThe namespace associated with the table.
name(impl Into<String>)/set_name(Option<String>):
required: trueThe name of the table.
- On success, responds with
GetTablePolicyOutputwith field(s):resource_policy(String):The
JSONthat defines the policy.
- On failure, responds with
SdkError<GetTablePolicyError>
Source§impl Client
impl Client
Sourcepub fn get_table_record_expiration_configuration(
&self,
) -> GetTableRecordExpirationConfigurationFluentBuilder
pub fn get_table_record_expiration_configuration( &self, ) -> GetTableRecordExpirationConfigurationFluentBuilder
Constructs a fluent builder for the GetTableRecordExpirationConfiguration operation.
- The fluent builder is configurable:
table_arn(impl Into<String>)/set_table_arn(Option<String>):
required: trueThe Amazon Resource Name (ARN) of the table.
- On success, responds with
GetTableRecordExpirationConfigurationOutputwith field(s):configuration(Option<TableRecordExpirationConfigurationValue>):The record expiration configuration for the table, including the status and retention settings.
- On failure, responds with
SdkError<GetTableRecordExpirationConfigurationError>
Source§impl Client
impl Client
Sourcepub fn get_table_record_expiration_job_status(
&self,
) -> GetTableRecordExpirationJobStatusFluentBuilder
pub fn get_table_record_expiration_job_status( &self, ) -> GetTableRecordExpirationJobStatusFluentBuilder
Constructs a fluent builder for the GetTableRecordExpirationJobStatus operation.
- The fluent builder is configurable:
table_arn(impl Into<String>)/set_table_arn(Option<String>):
required: trueThe Amazon Resource Name (ARN) of the table.
- On success, responds with
GetTableRecordExpirationJobStatusOutputwith field(s):status(TableRecordExpirationJobStatus):The current status of the most recent expiration job.
last_run_timestamp(Option<DateTime>):The timestamp when the expiration job was last executed.
failure_message(Option<String>):If the job failed, this field contains an error message describing the failure reason.
metrics(Option<TableRecordExpirationJobMetrics>):Metrics about the most recent expiration job execution, including the number of records and files deleted.
- On failure, responds with
SdkError<GetTableRecordExpirationJobStatusError>
Source§impl Client
impl Client
Sourcepub fn get_table_replication(&self) -> GetTableReplicationFluentBuilder
pub fn get_table_replication(&self) -> GetTableReplicationFluentBuilder
Constructs a fluent builder for the GetTableReplication operation.
- The fluent builder is configurable:
table_arn(impl Into<String>)/set_table_arn(Option<String>):
required: trueThe Amazon Resource Name (ARN) of the table.
- On success, responds with
GetTableReplicationOutputwith field(s):version_token(String):A version token that represents the current state of the table’s replication configuration. Use this token when updating the configuration to ensure consistency.
configuration(Option<TableReplicationConfiguration>):The replication configuration for the table, including the IAM role and replication rules.
- On failure, responds with
SdkError<GetTableReplicationError>
Source§impl Client
impl Client
Sourcepub fn get_table_replication_status(
&self,
) -> GetTableReplicationStatusFluentBuilder
pub fn get_table_replication_status( &self, ) -> GetTableReplicationStatusFluentBuilder
Constructs a fluent builder for the GetTableReplicationStatus operation.
- The fluent builder is configurable:
table_arn(impl Into<String>)/set_table_arn(Option<String>):
required: trueThe Amazon Resource Name (ARN) of the table.
- On success, responds with
GetTableReplicationStatusOutputwith field(s):source_table_arn(String):The Amazon Resource Name (ARN) of the source table being replicated.
destinations(Vec::<ReplicationDestinationStatusModel>):An array of status information for each replication destination, including the current state, last successful update, and any error messages.
- On failure, responds with
SdkError<GetTableReplicationStatusError>
Source§impl Client
impl Client
Sourcepub fn get_table_storage_class(&self) -> GetTableStorageClassFluentBuilder
pub fn get_table_storage_class(&self) -> GetTableStorageClassFluentBuilder
Constructs a fluent builder for the GetTableStorageClass operation.
- The fluent builder is configurable:
table_bucket_arn(impl Into<String>)/set_table_bucket_arn(Option<String>):
required: trueThe Amazon Resource Name (ARN) of the table bucket that contains the table.
namespace(impl Into<String>)/set_namespace(Option<String>):
required: trueThe namespace associated with the table.
name(impl Into<String>)/set_name(Option<String>):
required: trueThe name of the table.
- On success, responds with
GetTableStorageClassOutputwith field(s):storage_class_configuration(Option<StorageClassConfiguration>):The storage class configuration for the table.
- On failure, responds with
SdkError<GetTableStorageClassError>
Source§impl Client
impl Client
Sourcepub fn list_namespaces(&self) -> ListNamespacesFluentBuilder
pub fn list_namespaces(&self) -> ListNamespacesFluentBuilder
Constructs a fluent builder for the ListNamespaces operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
table_bucket_arn(impl Into<String>)/set_table_bucket_arn(Option<String>):
required: trueThe Amazon Resource Name (ARN) of the table bucket.
prefix(impl Into<String>)/set_prefix(Option<String>):
required: falseThe prefix of the namespaces.
continuation_token(impl Into<String>)/set_continuation_token(Option<String>):
required: falseContinuationTokenindicates to Amazon S3 that the list is being continued on this bucket with a token.ContinuationTokenis obfuscated and is not a real key. You can use thisContinuationTokenfor pagination of the list results.max_namespaces(i32)/set_max_namespaces(Option<i32>):
required: falseThe maximum number of namespaces to return in the list.
- On success, responds with
ListNamespacesOutputwith field(s):namespaces(Vec::<NamespaceSummary>):A list of namespaces.
continuation_token(Option<String>):The
ContinuationTokenfor pagination of the list results.
- On failure, responds with
SdkError<ListNamespacesError>
Source§impl Client
impl Client
Sourcepub fn list_table_buckets(&self) -> ListTableBucketsFluentBuilder
pub fn list_table_buckets(&self) -> ListTableBucketsFluentBuilder
Constructs a fluent builder for the ListTableBuckets operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
prefix(impl Into<String>)/set_prefix(Option<String>):
required: falseThe prefix of the table buckets.
continuation_token(impl Into<String>)/set_continuation_token(Option<String>):
required: falseContinuationTokenindicates to Amazon S3 that the list is being continued on this bucket with a token.ContinuationTokenis obfuscated and is not a real key. You can use thisContinuationTokenfor pagination of the list results.max_buckets(i32)/set_max_buckets(Option<i32>):
required: falseThe maximum number of table buckets to return in the list.
r#type(TableBucketType)/set_type(Option<TableBucketType>):
required: falseThe type of table buckets to filter by in the list.
- On success, responds with
ListTableBucketsOutputwith field(s):table_buckets(Vec::<TableBucketSummary>):A list of table buckets.
continuation_token(Option<String>):You can use this
ContinuationTokenfor pagination of the list results.
- On failure, responds with
SdkError<ListTableBucketsError>
Source§impl Client
impl Client
Sourcepub fn list_tables(&self) -> ListTablesFluentBuilder
pub fn list_tables(&self) -> ListTablesFluentBuilder
Constructs a fluent builder for the ListTables operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
table_bucket_arn(impl Into<String>)/set_table_bucket_arn(Option<String>):
required: trueThe Amazon resource Name (ARN) of the table bucket.
namespace(impl Into<String>)/set_namespace(Option<String>):
required: falseThe namespace of the tables.
prefix(impl Into<String>)/set_prefix(Option<String>):
required: falseThe prefix of the tables.
continuation_token(impl Into<String>)/set_continuation_token(Option<String>):
required: falseContinuationTokenindicates to Amazon S3 that the list is being continued on this bucket with a token.ContinuationTokenis obfuscated and is not a real key. You can use thisContinuationTokenfor pagination of the list results.max_tables(i32)/set_max_tables(Option<i32>):
required: falseThe maximum number of tables to return.
- On success, responds with
ListTablesOutputwith field(s):tables(Vec::<TableSummary>):A list of tables.
continuation_token(Option<String>):You can use this
ContinuationTokenfor pagination of the list results.
- On failure, responds with
SdkError<ListTablesError>
Source§impl Client
impl Client
Constructs a fluent builder for the ListTagsForResource operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)/set_resource_arn(Option<String>):
required: trueThe Amazon Resource Name (ARN) of the Amazon S3 Tables resource that you want to list tags for. The tagged resource can be a table bucket or a table. For a list of all S3 resources that support tagging, see Managing tags for Amazon S3 resources.
- On success, responds with
ListTagsForResourceOutputwith field(s):tags(Option<HashMap::<String, String>>):The user-defined tags that are applied to the resource. For more information, see Tagging for cost allocation or attribute-based access control (ABAC).
- On failure, responds with
SdkError<ListTagsForResourceError>
Source§impl Client
impl Client
Sourcepub fn put_table_bucket_encryption(
&self,
) -> PutTableBucketEncryptionFluentBuilder
pub fn put_table_bucket_encryption( &self, ) -> PutTableBucketEncryptionFluentBuilder
Constructs a fluent builder for the PutTableBucketEncryption operation.
- The fluent builder is configurable:
table_bucket_arn(impl Into<String>)/set_table_bucket_arn(Option<String>):
required: trueThe Amazon Resource Name (ARN) of the table bucket.
encryption_configuration(EncryptionConfiguration)/set_encryption_configuration(Option<EncryptionConfiguration>):
required: trueThe encryption configuration to apply to the table bucket.
- On success, responds with
PutTableBucketEncryptionOutput - On failure, responds with
SdkError<PutTableBucketEncryptionError>
Source§impl Client
impl Client
Sourcepub fn put_table_bucket_maintenance_configuration(
&self,
) -> PutTableBucketMaintenanceConfigurationFluentBuilder
pub fn put_table_bucket_maintenance_configuration( &self, ) -> PutTableBucketMaintenanceConfigurationFluentBuilder
Constructs a fluent builder for the PutTableBucketMaintenanceConfiguration operation.
- The fluent builder is configurable:
table_bucket_arn(impl Into<String>)/set_table_bucket_arn(Option<String>):
required: trueThe Amazon Resource Name (ARN) of the table bucket associated with the maintenance configuration.
r#type(TableBucketMaintenanceType)/set_type(Option<TableBucketMaintenanceType>):
required: trueThe type of the maintenance configuration.
value(TableBucketMaintenanceConfigurationValue)/set_value(Option<TableBucketMaintenanceConfigurationValue>):
required: trueDefines the values of the maintenance configuration for the table bucket.
- On success, responds with
PutTableBucketMaintenanceConfigurationOutput - On failure, responds with
SdkError<PutTableBucketMaintenanceConfigurationError>
Source§impl Client
impl Client
Sourcepub fn put_table_bucket_metrics_configuration(
&self,
) -> PutTableBucketMetricsConfigurationFluentBuilder
pub fn put_table_bucket_metrics_configuration( &self, ) -> PutTableBucketMetricsConfigurationFluentBuilder
Constructs a fluent builder for the PutTableBucketMetricsConfiguration operation.
- The fluent builder is configurable:
table_bucket_arn(impl Into<String>)/set_table_bucket_arn(Option<String>):
required: trueThe Amazon Resource Name (ARN) of the table bucket.
- On success, responds with
PutTableBucketMetricsConfigurationOutput - On failure, responds with
SdkError<PutTableBucketMetricsConfigurationError>
Source§impl Client
impl Client
Sourcepub fn put_table_bucket_policy(&self) -> PutTableBucketPolicyFluentBuilder
pub fn put_table_bucket_policy(&self) -> PutTableBucketPolicyFluentBuilder
Constructs a fluent builder for the PutTableBucketPolicy operation.
- The fluent builder is configurable:
table_bucket_arn(impl Into<String>)/set_table_bucket_arn(Option<String>):
required: trueThe Amazon Resource Name (ARN) of the table bucket.
resource_policy(impl Into<String>)/set_resource_policy(Option<String>):
required: trueThe
JSONthat defines the policy.
- On success, responds with
PutTableBucketPolicyOutput - On failure, responds with
SdkError<PutTableBucketPolicyError>
Source§impl Client
impl Client
Sourcepub fn put_table_bucket_replication(
&self,
) -> PutTableBucketReplicationFluentBuilder
pub fn put_table_bucket_replication( &self, ) -> PutTableBucketReplicationFluentBuilder
Constructs a fluent builder for the PutTableBucketReplication operation.
- The fluent builder is configurable:
table_bucket_arn(impl Into<String>)/set_table_bucket_arn(Option<String>):
required: trueThe Amazon Resource Name (ARN) of the source table bucket.
version_token(impl Into<String>)/set_version_token(Option<String>):
required: falseA version token from a previous GetTableBucketReplication call. Use this token to ensure you’re updating the expected version of the configuration.
configuration(TableBucketReplicationConfiguration)/set_configuration(Option<TableBucketReplicationConfiguration>):
required: trueThe replication configuration to apply, including the IAM role and replication rules.
- On success, responds with
PutTableBucketReplicationOutputwith field(s):version_token(String):A new version token representing the updated replication configuration.
status(String):The status of the replication configuration operation.
- On failure, responds with
SdkError<PutTableBucketReplicationError>
Source§impl Client
impl Client
Sourcepub fn put_table_bucket_storage_class(
&self,
) -> PutTableBucketStorageClassFluentBuilder
pub fn put_table_bucket_storage_class( &self, ) -> PutTableBucketStorageClassFluentBuilder
Constructs a fluent builder for the PutTableBucketStorageClass operation.
- The fluent builder is configurable:
table_bucket_arn(impl Into<String>)/set_table_bucket_arn(Option<String>):
required: trueThe Amazon Resource Name (ARN) of the table bucket.
storage_class_configuration(StorageClassConfiguration)/set_storage_class_configuration(Option<StorageClassConfiguration>):
required: trueThe storage class configuration to apply to the table bucket. This configuration will serve as the default for new tables created in this bucket.
- On success, responds with
PutTableBucketStorageClassOutput - On failure, responds with
SdkError<PutTableBucketStorageClassError>
Source§impl Client
impl Client
Sourcepub fn put_table_maintenance_configuration(
&self,
) -> PutTableMaintenanceConfigurationFluentBuilder
pub fn put_table_maintenance_configuration( &self, ) -> PutTableMaintenanceConfigurationFluentBuilder
Constructs a fluent builder for the PutTableMaintenanceConfiguration operation.
- The fluent builder is configurable:
table_bucket_arn(impl Into<String>)/set_table_bucket_arn(Option<String>):
required: trueThe Amazon Resource Name (ARN) of the table associated with the maintenance configuration.
namespace(impl Into<String>)/set_namespace(Option<String>):
required: trueThe namespace of the table.
name(impl Into<String>)/set_name(Option<String>):
required: trueThe name of the table.
r#type(TableMaintenanceType)/set_type(Option<TableMaintenanceType>):
required: trueThe type of the maintenance configuration.
value(TableMaintenanceConfigurationValue)/set_value(Option<TableMaintenanceConfigurationValue>):
required: trueDefines the values of the maintenance configuration for the table.
- On success, responds with
PutTableMaintenanceConfigurationOutput - On failure, responds with
SdkError<PutTableMaintenanceConfigurationError>
Source§impl Client
impl Client
Sourcepub fn put_table_policy(&self) -> PutTablePolicyFluentBuilder
pub fn put_table_policy(&self) -> PutTablePolicyFluentBuilder
Constructs a fluent builder for the PutTablePolicy operation.
- The fluent builder is configurable:
table_bucket_arn(impl Into<String>)/set_table_bucket_arn(Option<String>):
required: trueThe Amazon Resource Name (ARN) of the table bucket that contains the table.
namespace(impl Into<String>)/set_namespace(Option<String>):
required: trueThe namespace associated with the table.
name(impl Into<String>)/set_name(Option<String>):
required: trueThe name of the table.
resource_policy(impl Into<String>)/set_resource_policy(Option<String>):
required: trueThe
JSONthat defines the policy.
- On success, responds with
PutTablePolicyOutput - On failure, responds with
SdkError<PutTablePolicyError>
Source§impl Client
impl Client
Sourcepub fn put_table_record_expiration_configuration(
&self,
) -> PutTableRecordExpirationConfigurationFluentBuilder
pub fn put_table_record_expiration_configuration( &self, ) -> PutTableRecordExpirationConfigurationFluentBuilder
Constructs a fluent builder for the PutTableRecordExpirationConfiguration operation.
- The fluent builder is configurable:
table_arn(impl Into<String>)/set_table_arn(Option<String>):
required: trueThe Amazon Resource Name (ARN) of the table.
value(TableRecordExpirationConfigurationValue)/set_value(Option<TableRecordExpirationConfigurationValue>):
required: trueThe record expiration configuration to apply to the table, including the status (
enabledordisabled) and retention period in days.
- On success, responds with
PutTableRecordExpirationConfigurationOutput - On failure, responds with
SdkError<PutTableRecordExpirationConfigurationError>
Source§impl Client
impl Client
Sourcepub fn put_table_replication(&self) -> PutTableReplicationFluentBuilder
pub fn put_table_replication(&self) -> PutTableReplicationFluentBuilder
Constructs a fluent builder for the PutTableReplication operation.
- The fluent builder is configurable:
table_arn(impl Into<String>)/set_table_arn(Option<String>):
required: trueThe Amazon Resource Name (ARN) of the source table.
version_token(impl Into<String>)/set_version_token(Option<String>):
required: falseA version token from a previous GetTableReplication call. Use this token to ensure you’re updating the expected version of the configuration.
configuration(TableReplicationConfiguration)/set_configuration(Option<TableReplicationConfiguration>):
required: trueThe replication configuration to apply to the table, including the IAM role and replication rules.
- On success, responds with
PutTableReplicationOutputwith field(s):version_token(String):A new version token representing the updated replication configuration.
status(String):The status of the replication configuration operation.
- On failure, responds with
SdkError<PutTableReplicationError>
Source§impl Client
impl Client
Sourcepub fn rename_table(&self) -> RenameTableFluentBuilder
pub fn rename_table(&self) -> RenameTableFluentBuilder
Constructs a fluent builder for the RenameTable operation.
- The fluent builder is configurable:
table_bucket_arn(impl Into<String>)/set_table_bucket_arn(Option<String>):
required: trueThe Amazon Resource Name (ARN) of the table bucket.
namespace(impl Into<String>)/set_namespace(Option<String>):
required: trueThe namespace associated with the table.
name(impl Into<String>)/set_name(Option<String>):
required: trueThe current name of the table.
new_namespace_name(impl Into<String>)/set_new_namespace_name(Option<String>):
required: falseThe new name for the namespace.
new_name(impl Into<String>)/set_new_name(Option<String>):
required: falseThe new name for the table.
version_token(impl Into<String>)/set_version_token(Option<String>):
required: falseThe version token of the table.
- On success, responds with
RenameTableOutput - On failure, responds with
SdkError<RenameTableError>
Source§impl Client
impl Client
Sourcepub fn tag_resource(&self) -> TagResourceFluentBuilder
pub fn tag_resource(&self) -> TagResourceFluentBuilder
Constructs a fluent builder for the TagResource operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)/set_resource_arn(Option<String>):
required: trueThe Amazon Resource Name (ARN) of the Amazon S3 Tables resource that you’re applying tags to. The tagged resource can be a table bucket or a table. For a list of all S3 resources that support tagging, see Managing tags for Amazon S3 resources.
tags(impl Into<String>, impl Into<String>)/set_tags(Option<HashMap::<String, String>>):
required: trueThe user-defined tag that you want to add to the specified S3 Tables resource. For more information, see Tagging for cost allocation or attribute-based access control (ABAC).
- On success, responds with
TagResourceOutput - On failure, responds with
SdkError<TagResourceError>
Source§impl Client
impl Client
Sourcepub fn untag_resource(&self) -> UntagResourceFluentBuilder
pub fn untag_resource(&self) -> UntagResourceFluentBuilder
Constructs a fluent builder for the UntagResource operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)/set_resource_arn(Option<String>):
required: trueThe Amazon Resource Name (ARN) of the Amazon S3 Tables resource that you’re removing tags from. The tagged resource can be a table bucket or a table. For a list of all S3 resources that support tagging, see Managing tags for Amazon S3 resources.
tag_keys(impl Into<String>)/set_tag_keys(Option<Vec::<String>>):
required: trueThe array of tag keys that you’re removing from the S3 Tables resource. For more information, see Tagging for cost allocation or attribute-based access control (ABAC).
- On success, responds with
UntagResourceOutput - On failure, responds with
SdkError<UntagResourceError>
Source§impl Client
impl Client
Sourcepub fn update_table_metadata_location(
&self,
) -> UpdateTableMetadataLocationFluentBuilder
pub fn update_table_metadata_location( &self, ) -> UpdateTableMetadataLocationFluentBuilder
Constructs a fluent builder for the UpdateTableMetadataLocation operation.
- The fluent builder is configurable:
table_bucket_arn(impl Into<String>)/set_table_bucket_arn(Option<String>):
required: trueThe Amazon Resource Name (ARN) of the table bucket.
namespace(impl Into<String>)/set_namespace(Option<String>):
required: trueThe namespace of the table.
name(impl Into<String>)/set_name(Option<String>):
required: trueThe name of the table.
version_token(impl Into<String>)/set_version_token(Option<String>):
required: trueThe version token of the table.
metadata_location(impl Into<String>)/set_metadata_location(Option<String>):
required: trueThe new metadata location for the table.
- On success, responds with
UpdateTableMetadataLocationOutputwith field(s):name(String):The name of the table.
table_arn(String):The Amazon Resource Name (ARN) of the table.
namespace(Vec::<String>):The namespace the table is associated with.
version_token(String):The version token of the table.
metadata_location(String):The metadata location of the table.
- On failure, responds with
SdkError<UpdateTableMetadataLocationError>
Source§impl Client
impl Client
Sourcepub fn from_conf(conf: Config) -> Self
pub fn from_conf(conf: Config) -> Self
Creates a new client from the service Config.
§Panics
This method will panic in the following cases:
- Retries or timeouts are enabled without a
sleep_implconfigured. - Identity caching is enabled without a
sleep_implandtime_sourceconfigured. - No
behavior_versionis provided.
The panic message for each of these will have instructions on how to resolve them.
Source§impl Client
impl Client
Sourcepub fn new(sdk_config: &SdkConfig) -> Self
pub fn new(sdk_config: &SdkConfig) -> Self
Creates a new client from an SDK Config.
§Panics
- This method will panic if the
sdk_configis missing an async sleep implementation. If you experience this panic, set thesleep_implon the Config passed into this function to fix it. - This method will panic if the
sdk_configis missing an HTTP connector. If you experience this panic, set thehttp_connectoron the Config passed into this function to fix it. - This method will panic if no
BehaviorVersionis provided. If you experience this panic, setbehavior_versionon the Config or enable thebehavior-version-latestCargo feature.
Trait Implementations§
Auto Trait Implementations§
impl Freeze for Client
impl !RefUnwindSafe for Client
impl Send for Client
impl Sync for Client
impl Unpin for Client
impl !UnwindSafe for Client
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);