Struct ResourceDetails

Source
#[non_exhaustive]
pub struct ResourceDetails {
Show 99 fields pub aws_auto_scaling_auto_scaling_group: Option<AwsAutoScalingAutoScalingGroupDetails>, pub aws_code_build_project: Option<AwsCodeBuildProjectDetails>, pub aws_cloud_front_distribution: Option<AwsCloudFrontDistributionDetails>, pub aws_ec2_instance: Option<AwsEc2InstanceDetails>, pub aws_ec2_network_interface: Option<AwsEc2NetworkInterfaceDetails>, pub aws_ec2_security_group: Option<AwsEc2SecurityGroupDetails>, pub aws_ec2_volume: Option<AwsEc2VolumeDetails>, pub aws_ec2_vpc: Option<AwsEc2VpcDetails>, pub aws_ec2_eip: Option<AwsEc2EipDetails>, pub aws_ec2_subnet: Option<AwsEc2SubnetDetails>, pub aws_ec2_network_acl: Option<AwsEc2NetworkAclDetails>, pub aws_elbv2_load_balancer: Option<AwsElbv2LoadBalancerDetails>, pub aws_elastic_beanstalk_environment: Option<AwsElasticBeanstalkEnvironmentDetails>, pub aws_elasticsearch_domain: Option<AwsElasticsearchDomainDetails>, pub aws_s3_bucket: Option<AwsS3BucketDetails>, pub aws_s3_account_public_access_block: Option<AwsS3AccountPublicAccessBlockDetails>, pub aws_s3_object: Option<AwsS3ObjectDetails>, pub aws_secrets_manager_secret: Option<AwsSecretsManagerSecretDetails>, pub aws_iam_access_key: Option<AwsIamAccessKeyDetails>, pub aws_iam_user: Option<AwsIamUserDetails>, pub aws_iam_policy: Option<AwsIamPolicyDetails>, pub aws_api_gateway_v2_stage: Option<AwsApiGatewayV2StageDetails>, pub aws_api_gateway_v2_api: Option<AwsApiGatewayV2ApiDetails>, pub aws_dynamo_db_table: Option<AwsDynamoDbTableDetails>, pub aws_api_gateway_stage: Option<AwsApiGatewayStageDetails>, pub aws_api_gateway_rest_api: Option<AwsApiGatewayRestApiDetails>, pub aws_cloud_trail_trail: Option<AwsCloudTrailTrailDetails>, pub aws_ssm_patch_compliance: Option<AwsSsmPatchComplianceDetails>, pub aws_certificate_manager_certificate: Option<AwsCertificateManagerCertificateDetails>, pub aws_redshift_cluster: Option<AwsRedshiftClusterDetails>, pub aws_elb_load_balancer: Option<AwsElbLoadBalancerDetails>, pub aws_iam_group: Option<AwsIamGroupDetails>, pub aws_iam_role: Option<AwsIamRoleDetails>, pub aws_kms_key: Option<AwsKmsKeyDetails>, pub aws_lambda_function: Option<AwsLambdaFunctionDetails>, pub aws_lambda_layer_version: Option<AwsLambdaLayerVersionDetails>, pub aws_rds_db_instance: Option<AwsRdsDbInstanceDetails>, pub aws_sns_topic: Option<AwsSnsTopicDetails>, pub aws_sqs_queue: Option<AwsSqsQueueDetails>, pub aws_waf_web_acl: Option<AwsWafWebAclDetails>, pub aws_rds_db_snapshot: Option<AwsRdsDbSnapshotDetails>, pub aws_rds_db_cluster_snapshot: Option<AwsRdsDbClusterSnapshotDetails>, pub aws_rds_db_cluster: Option<AwsRdsDbClusterDetails>, pub aws_ecs_cluster: Option<AwsEcsClusterDetails>, pub aws_ecs_container: Option<AwsEcsContainerDetails>, pub aws_ecs_task_definition: Option<AwsEcsTaskDefinitionDetails>, pub container: Option<ContainerDetails>, pub other: Option<HashMap<String, String>>, pub aws_rds_event_subscription: Option<AwsRdsEventSubscriptionDetails>, pub aws_ecs_service: Option<AwsEcsServiceDetails>, pub aws_auto_scaling_launch_configuration: Option<AwsAutoScalingLaunchConfigurationDetails>, pub aws_ec2_vpn_connection: Option<AwsEc2VpnConnectionDetails>, pub aws_ecr_container_image: Option<AwsEcrContainerImageDetails>, pub aws_open_search_service_domain: Option<AwsOpenSearchServiceDomainDetails>, pub aws_ec2_vpc_endpoint_service: Option<AwsEc2VpcEndpointServiceDetails>, pub aws_xray_encryption_config: Option<AwsXrayEncryptionConfigDetails>, pub aws_waf_rate_based_rule: Option<AwsWafRateBasedRuleDetails>, pub aws_waf_regional_rate_based_rule: Option<AwsWafRegionalRateBasedRuleDetails>, pub aws_ecr_repository: Option<AwsEcrRepositoryDetails>, pub aws_eks_cluster: Option<AwsEksClusterDetails>, pub aws_network_firewall_firewall_policy: Option<AwsNetworkFirewallFirewallPolicyDetails>, pub aws_network_firewall_firewall: Option<AwsNetworkFirewallFirewallDetails>, pub aws_network_firewall_rule_group: Option<AwsNetworkFirewallRuleGroupDetails>, pub aws_rds_db_security_group: Option<AwsRdsDbSecurityGroupDetails>, pub aws_kinesis_stream: Option<AwsKinesisStreamDetails>, pub aws_ec2_transit_gateway: Option<AwsEc2TransitGatewayDetails>, pub aws_efs_access_point: Option<AwsEfsAccessPointDetails>, pub aws_cloud_formation_stack: Option<AwsCloudFormationStackDetails>, pub aws_cloud_watch_alarm: Option<AwsCloudWatchAlarmDetails>, pub aws_ec2_vpc_peering_connection: Option<AwsEc2VpcPeeringConnectionDetails>, pub aws_waf_regional_rule_group: Option<AwsWafRegionalRuleGroupDetails>, pub aws_waf_regional_rule: Option<AwsWafRegionalRuleDetails>, pub aws_waf_regional_web_acl: Option<AwsWafRegionalWebAclDetails>, pub aws_waf_rule: Option<AwsWafRuleDetails>, pub aws_waf_rule_group: Option<AwsWafRuleGroupDetails>, pub aws_ecs_task: Option<AwsEcsTaskDetails>, pub aws_backup_backup_vault: Option<AwsBackupBackupVaultDetails>, pub aws_backup_backup_plan: Option<AwsBackupBackupPlanDetails>, pub aws_backup_recovery_point: Option<AwsBackupRecoveryPointDetails>, pub aws_ec2_launch_template: Option<AwsEc2LaunchTemplateDetails>, pub aws_sage_maker_notebook_instance: Option<AwsSageMakerNotebookInstanceDetails>, pub aws_wafv2_web_acl: Option<AwsWafv2WebAclDetails>, pub aws_wafv2_rule_group: Option<AwsWafv2RuleGroupDetails>, pub aws_ec2_route_table: Option<AwsEc2RouteTableDetails>, pub aws_amazon_mq_broker: Option<AwsAmazonMqBrokerDetails>, pub aws_app_sync_graph_ql_api: Option<AwsAppSyncGraphQlApiDetails>, pub aws_event_schemas_registry: Option<AwsEventSchemasRegistryDetails>, pub aws_guard_duty_detector: Option<AwsGuardDutyDetectorDetails>, pub aws_step_function_state_machine: Option<AwsStepFunctionStateMachineDetails>, pub aws_athena_work_group: Option<AwsAthenaWorkGroupDetails>, pub aws_events_eventbus: Option<AwsEventsEventbusDetails>, pub aws_dms_endpoint: Option<AwsDmsEndpointDetails>, pub aws_events_endpoint: Option<AwsEventsEndpointDetails>, pub aws_dms_replication_task: Option<AwsDmsReplicationTaskDetails>, pub aws_dms_replication_instance: Option<AwsDmsReplicationInstanceDetails>, pub aws_route53_hosted_zone: Option<AwsRoute53HostedZoneDetails>, pub aws_msk_cluster: Option<AwsMskClusterDetails>, pub aws_s3_access_point: Option<AwsS3AccessPointDetails>, pub aws_ec2_client_vpn_endpoint: Option<AwsEc2ClientVpnEndpointDetails>,
}
Expand description

Additional details about a resource related to a finding.

To provide the details, use the object that corresponds to the resource type. For example, if the resource type is AwsEc2Instance, then you use the AwsEc2Instance object to provide the details.

If the type-specific object does not contain all of the fields you want to populate, then you use the Other object to populate those additional fields.

You also use the Other object to populate the details when the selected type does not have a corresponding object.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§aws_auto_scaling_auto_scaling_group: Option<AwsAutoScalingAutoScalingGroupDetails>

Details for an autoscaling group.

§aws_code_build_project: Option<AwsCodeBuildProjectDetails>

Details for an CodeBuild project.

§aws_cloud_front_distribution: Option<AwsCloudFrontDistributionDetails>

Details about a CloudFront distribution.

§aws_ec2_instance: Option<AwsEc2InstanceDetails>

Details about an EC2 instance related to a finding.

§aws_ec2_network_interface: Option<AwsEc2NetworkInterfaceDetails>

Details for an EC2 network interface.

§aws_ec2_security_group: Option<AwsEc2SecurityGroupDetails>

Details for an EC2 security group.

§aws_ec2_volume: Option<AwsEc2VolumeDetails>

Details for an Amazon EC2 volume.

§aws_ec2_vpc: Option<AwsEc2VpcDetails>

Details for an Amazon EC2 VPC.

§aws_ec2_eip: Option<AwsEc2EipDetails>

Details about an Elastic IP address.

§aws_ec2_subnet: Option<AwsEc2SubnetDetails>

Details about a subnet in Amazon EC2.

§aws_ec2_network_acl: Option<AwsEc2NetworkAclDetails>

Details about an EC2 network access control list (ACL).

§aws_elbv2_load_balancer: Option<AwsElbv2LoadBalancerDetails>

Details about a load balancer.

§aws_elastic_beanstalk_environment: Option<AwsElasticBeanstalkEnvironmentDetails>

Details about an Elastic Beanstalk environment.

§aws_elasticsearch_domain: Option<AwsElasticsearchDomainDetails>

Details for an Elasticsearch domain.

§aws_s3_bucket: Option<AwsS3BucketDetails>

Details about an S3 bucket related to a finding.

§aws_s3_account_public_access_block: Option<AwsS3AccountPublicAccessBlockDetails>

Details about the Amazon S3 Public Access Block configuration for an account.

§aws_s3_object: Option<AwsS3ObjectDetails>

Details about an S3 object related to a finding.

§aws_secrets_manager_secret: Option<AwsSecretsManagerSecretDetails>

Details about a Secrets Manager secret.

§aws_iam_access_key: Option<AwsIamAccessKeyDetails>

Details about an IAM access key related to a finding.

§aws_iam_user: Option<AwsIamUserDetails>

Details about an IAM user.

§aws_iam_policy: Option<AwsIamPolicyDetails>

Details about an IAM permissions policy.

§aws_api_gateway_v2_stage: Option<AwsApiGatewayV2StageDetails>

Provides information about a version 2 stage for Amazon API Gateway.

§aws_api_gateway_v2_api: Option<AwsApiGatewayV2ApiDetails>

Provides information about a version 2 API in Amazon API Gateway.

§aws_dynamo_db_table: Option<AwsDynamoDbTableDetails>

Details about a DynamoDB table.

§aws_api_gateway_stage: Option<AwsApiGatewayStageDetails>

Provides information about a version 1 Amazon API Gateway stage.

§aws_api_gateway_rest_api: Option<AwsApiGatewayRestApiDetails>

Provides information about a REST API in version 1 of Amazon API Gateway.

§aws_cloud_trail_trail: Option<AwsCloudTrailTrailDetails>

Provides details about a CloudTrail trail.

§aws_ssm_patch_compliance: Option<AwsSsmPatchComplianceDetails>

Provides information about the state of a patch on an instance based on the patch baseline that was used to patch the instance.

§aws_certificate_manager_certificate: Option<AwsCertificateManagerCertificateDetails>

Provides details about an Certificate Manager certificate.

§aws_redshift_cluster: Option<AwsRedshiftClusterDetails>

Contains details about an Amazon Redshift cluster.

§aws_elb_load_balancer: Option<AwsElbLoadBalancerDetails>

Contains details about a Classic Load Balancer.

§aws_iam_group: Option<AwsIamGroupDetails>

Contains details about an IAM group.

§aws_iam_role: Option<AwsIamRoleDetails>

Details about an IAM role.

§aws_kms_key: Option<AwsKmsKeyDetails>

Details about an KMS key.

§aws_lambda_function: Option<AwsLambdaFunctionDetails>

Details about a Lambda function.

§aws_lambda_layer_version: Option<AwsLambdaLayerVersionDetails>

Details for a Lambda layer version.

§aws_rds_db_instance: Option<AwsRdsDbInstanceDetails>

Details about an Amazon RDS database instance.

§aws_sns_topic: Option<AwsSnsTopicDetails>

Details about an SNS topic.

§aws_sqs_queue: Option<AwsSqsQueueDetails>

Details about an SQS queue.

§aws_waf_web_acl: Option<AwsWafWebAclDetails>

Details for an WAF web ACL.

§aws_rds_db_snapshot: Option<AwsRdsDbSnapshotDetails>

Details about an Amazon RDS database snapshot.

§aws_rds_db_cluster_snapshot: Option<AwsRdsDbClusterSnapshotDetails>

Details about an Amazon RDS database cluster snapshot.

§aws_rds_db_cluster: Option<AwsRdsDbClusterDetails>

Details about an Amazon RDS database cluster.

§aws_ecs_cluster: Option<AwsEcsClusterDetails>

Details about an Amazon ECS cluster.

§aws_ecs_container: Option<AwsEcsContainerDetails>

Provides information about a Docker container that's part of a task.

§aws_ecs_task_definition: Option<AwsEcsTaskDefinitionDetails>

Details about a task definition. A task definition describes the container and volume definitions of an Amazon Elastic Container Service task.

§container: Option<ContainerDetails>

Details about a container resource related to a finding.

§other: Option<HashMap<String, String>>

Details about a resource that are not available in a type-specific details object. Use the Other object in the following cases.

  • The type-specific object does not contain all of the fields that you want to populate. In this case, first use the type-specific object to populate those fields. Use the Other object to populate the fields that are missing from the type-specific object.

  • The resource type does not have a corresponding object. This includes resources for which the type is Other.

§aws_rds_event_subscription: Option<AwsRdsEventSubscriptionDetails>

Details about an RDS event notification subscription.

§aws_ecs_service: Option<AwsEcsServiceDetails>

Details about a service within an ECS cluster.

§aws_auto_scaling_launch_configuration: Option<AwsAutoScalingLaunchConfigurationDetails>

Provides details about a launch configuration.

§aws_ec2_vpn_connection: Option<AwsEc2VpnConnectionDetails>

Details about an Amazon EC2 VPN connection.

§aws_ecr_container_image: Option<AwsEcrContainerImageDetails>

Information about an Amazon ECR image.

§aws_open_search_service_domain: Option<AwsOpenSearchServiceDomainDetails>

Details about an Amazon OpenSearch Service domain.

§aws_ec2_vpc_endpoint_service: Option<AwsEc2VpcEndpointServiceDetails>

Details about the service configuration for a VPC endpoint service.

§aws_xray_encryption_config: Option<AwsXrayEncryptionConfigDetails>

Information about the encryption configuration for X-Ray.

§aws_waf_rate_based_rule: Option<AwsWafRateBasedRuleDetails>

Details about a rate-based rule for global resources.

§aws_waf_regional_rate_based_rule: Option<AwsWafRegionalRateBasedRuleDetails>

Details about a rate-based rule for Regional resources.

§aws_ecr_repository: Option<AwsEcrRepositoryDetails>

Information about an Amazon Elastic Container Registry repository.

§aws_eks_cluster: Option<AwsEksClusterDetails>

Details about an Amazon EKS cluster.

§aws_network_firewall_firewall_policy: Option<AwsNetworkFirewallFirewallPolicyDetails>

Details about an Network Firewall firewall policy.

§aws_network_firewall_firewall: Option<AwsNetworkFirewallFirewallDetails>

Details about an Network Firewall firewall.

§aws_network_firewall_rule_group: Option<AwsNetworkFirewallRuleGroupDetails>

Details about an Network Firewall rule group.

§aws_rds_db_security_group: Option<AwsRdsDbSecurityGroupDetails>

Details about an Amazon RDS DB security group.

§aws_kinesis_stream: Option<AwsKinesisStreamDetails>

Details about an Amazon Kinesis data stream.

§aws_ec2_transit_gateway: Option<AwsEc2TransitGatewayDetails>

Details about an Amazon EC2 transit gateway that interconnects your virtual private clouds (VPC) and on-premises networks.

§aws_efs_access_point: Option<AwsEfsAccessPointDetails>

Details about an Amazon EFS access point. An access point is an application-specific view into an EFS file system that applies an operating system user and group, and a file system path, to any file system request made through the access point.

§aws_cloud_formation_stack: Option<AwsCloudFormationStackDetails>

Details about an CloudFormation stack. A stack is a collection of Amazon Web Services resources that you can manage as a single unit.

§aws_cloud_watch_alarm: Option<AwsCloudWatchAlarmDetails>

Details about an Amazon CloudWatch alarm. An alarm allows you to monitor and receive alerts about your Amazon Web Services resources and applications across multiple Regions.

§aws_ec2_vpc_peering_connection: Option<AwsEc2VpcPeeringConnectionDetails>

Details about an Amazon EC2 VPC peering connection. A VPC peering connection is a networking connection between two VPCs that enables you to route traffic between them privately.

§aws_waf_regional_rule_group: Option<AwsWafRegionalRuleGroupDetails>

Details about an WAF rule group for Regional resources.

§aws_waf_regional_rule: Option<AwsWafRegionalRuleDetails>

Details about an WAF rule for Regional resources.

§aws_waf_regional_web_acl: Option<AwsWafRegionalWebAclDetails>

Details about an WAF web access control list (web ACL) for Regional resources.

§aws_waf_rule: Option<AwsWafRuleDetails>

Details about an WAF rule for global resources.

§aws_waf_rule_group: Option<AwsWafRuleGroupDetails>

Details about an WAF rule group for global resources.

§aws_ecs_task: Option<AwsEcsTaskDetails>

Details about a task in a cluster.

§aws_backup_backup_vault: Option<AwsBackupBackupVaultDetails>

Provides details about an Backup backup vault.

§aws_backup_backup_plan: Option<AwsBackupBackupPlanDetails>

Provides details about an Backup backup plan.

§aws_backup_recovery_point: Option<AwsBackupRecoveryPointDetails>

Provides details about an Backup backup, or recovery point.

§aws_ec2_launch_template: Option<AwsEc2LaunchTemplateDetails>

Specifies the properties for creating an Amazon Elastic Compute Cloud (Amazon EC2) launch template.

§aws_sage_maker_notebook_instance: Option<AwsSageMakerNotebookInstanceDetails>

Provides details about an Amazon SageMaker AI notebook instance.

§aws_wafv2_web_acl: Option<AwsWafv2WebAclDetails>

Details about an WAFv2 web Access Control List (ACL).

§aws_wafv2_rule_group: Option<AwsWafv2RuleGroupDetails>

Details about an WAFv2 rule group.

§aws_ec2_route_table: Option<AwsEc2RouteTableDetails>

Provides details about a route table. A route table contains a set of rules, called routes, that determine where to direct network traffic from your subnet or gateway.

§aws_amazon_mq_broker: Option<AwsAmazonMqBrokerDetails>

Provides details about AppSync message broker. A message broker allows software applications and components to communicate using various programming languages, operating systems, and formal messaging protocols.

§aws_app_sync_graph_ql_api: Option<AwsAppSyncGraphQlApiDetails>

Provides details about an AppSync Graph QL API, which lets you query multiple databases, microservices, and APIs from a single GraphQL endpoint.

§aws_event_schemas_registry: Option<AwsEventSchemasRegistryDetails>

A schema defines the structure of events that are sent to Amazon EventBridge. Schema registries are containers for schemas. They collect and organize schemas so that your schemas are in logical groups.

§aws_guard_duty_detector: Option<AwsGuardDutyDetectorDetails>

Provides details about an Amazon GuardDuty detector. A detector is an object that represents the GuardDuty service. A detector is required for GuardDuty to become operational.

§aws_step_function_state_machine: Option<AwsStepFunctionStateMachineDetails>

Provides details about an Step Functions state machine, which is a workflow consisting of a series of event-driven steps.

§aws_athena_work_group: Option<AwsAthenaWorkGroupDetails>

Provides information about an Amazon Athena workgroup. A workgroup helps you separate users, teams, applications, or workloads. It also helps you set limits on data processing and track costs.

§aws_events_eventbus: Option<AwsEventsEventbusDetails>

Provides details about Amazon EventBridge event bus for an endpoint. An event bus is a router that receives events and delivers them to zero or more destinations, or targets.

§aws_dms_endpoint: Option<AwsDmsEndpointDetails>

Provides details about an Database Migration Service (DMS) endpoint. An endpoint provides connection, data store type, and location information about your data store.

§aws_events_endpoint: Option<AwsEventsEndpointDetails>

Provides details about an Amazon EventBridge global endpoint. The endpoint can improve your application’s availability by making it Regional-fault tolerant.

§aws_dms_replication_task: Option<AwsDmsReplicationTaskDetails>

Provides details about an DMS replication task. A replication task moves a set of data from the source endpoint to the target endpoint.

§aws_dms_replication_instance: Option<AwsDmsReplicationInstanceDetails>

Provides details about an DMS replication instance. DMS uses a replication instance to connect to your source data store, read the source data, and format the data for consumption by the target data store.

§aws_route53_hosted_zone: Option<AwsRoute53HostedZoneDetails>

Provides details about an Amazon Route 53 hosted zone, including the four name servers assigned to the hosted zone. A hosted zone represents a collection of records that can be managed together, belonging to a single parent domain name.

§aws_msk_cluster: Option<AwsMskClusterDetails>

Provides details about an Amazon Managed Streaming for Apache Kafka (Amazon MSK) cluster.

§aws_s3_access_point: Option<AwsS3AccessPointDetails>

Provides details about an Amazon Simple Storage Service (Amazon S3) access point. S3 access points are named network endpoints that are attached to S3 buckets that you can use to perform S3 object operations.

§aws_ec2_client_vpn_endpoint: Option<AwsEc2ClientVpnEndpointDetails>

Provides details about an Client VPN endpoint. A Client VPN endpoint is the resource that you create and configure to enable and manage client VPN sessions. It's the termination point for all client VPN sessions.

Implementations§

Source§

impl ResourceDetails

Source

pub fn aws_auto_scaling_auto_scaling_group( &self, ) -> Option<&AwsAutoScalingAutoScalingGroupDetails>

Details for an autoscaling group.

Source

pub fn aws_code_build_project(&self) -> Option<&AwsCodeBuildProjectDetails>

Details for an CodeBuild project.

Source

pub fn aws_cloud_front_distribution( &self, ) -> Option<&AwsCloudFrontDistributionDetails>

Details about a CloudFront distribution.

Source

pub fn aws_ec2_instance(&self) -> Option<&AwsEc2InstanceDetails>

Details about an EC2 instance related to a finding.

Source

pub fn aws_ec2_network_interface( &self, ) -> Option<&AwsEc2NetworkInterfaceDetails>

Details for an EC2 network interface.

Source

pub fn aws_ec2_security_group(&self) -> Option<&AwsEc2SecurityGroupDetails>

Details for an EC2 security group.

Source

pub fn aws_ec2_volume(&self) -> Option<&AwsEc2VolumeDetails>

Details for an Amazon EC2 volume.

Source

pub fn aws_ec2_vpc(&self) -> Option<&AwsEc2VpcDetails>

Details for an Amazon EC2 VPC.

Source

pub fn aws_ec2_eip(&self) -> Option<&AwsEc2EipDetails>

Details about an Elastic IP address.

Source

pub fn aws_ec2_subnet(&self) -> Option<&AwsEc2SubnetDetails>

Details about a subnet in Amazon EC2.

Source

pub fn aws_ec2_network_acl(&self) -> Option<&AwsEc2NetworkAclDetails>

Details about an EC2 network access control list (ACL).

Source

pub fn aws_elbv2_load_balancer(&self) -> Option<&AwsElbv2LoadBalancerDetails>

Details about a load balancer.

Source

pub fn aws_elastic_beanstalk_environment( &self, ) -> Option<&AwsElasticBeanstalkEnvironmentDetails>

Details about an Elastic Beanstalk environment.

Source

pub fn aws_elasticsearch_domain(&self) -> Option<&AwsElasticsearchDomainDetails>

Details for an Elasticsearch domain.

Source

pub fn aws_s3_bucket(&self) -> Option<&AwsS3BucketDetails>

Details about an S3 bucket related to a finding.

Source

pub fn aws_s3_account_public_access_block( &self, ) -> Option<&AwsS3AccountPublicAccessBlockDetails>

Details about the Amazon S3 Public Access Block configuration for an account.

Source

pub fn aws_s3_object(&self) -> Option<&AwsS3ObjectDetails>

Details about an S3 object related to a finding.

Source

pub fn aws_secrets_manager_secret( &self, ) -> Option<&AwsSecretsManagerSecretDetails>

Details about a Secrets Manager secret.

Source

pub fn aws_iam_access_key(&self) -> Option<&AwsIamAccessKeyDetails>

Details about an IAM access key related to a finding.

Source

pub fn aws_iam_user(&self) -> Option<&AwsIamUserDetails>

Details about an IAM user.

Source

pub fn aws_iam_policy(&self) -> Option<&AwsIamPolicyDetails>

Details about an IAM permissions policy.

Source

pub fn aws_api_gateway_v2_stage(&self) -> Option<&AwsApiGatewayV2StageDetails>

Provides information about a version 2 stage for Amazon API Gateway.

Source

pub fn aws_api_gateway_v2_api(&self) -> Option<&AwsApiGatewayV2ApiDetails>

Provides information about a version 2 API in Amazon API Gateway.

Source

pub fn aws_dynamo_db_table(&self) -> Option<&AwsDynamoDbTableDetails>

Details about a DynamoDB table.

Source

pub fn aws_api_gateway_stage(&self) -> Option<&AwsApiGatewayStageDetails>

Provides information about a version 1 Amazon API Gateway stage.

Source

pub fn aws_api_gateway_rest_api(&self) -> Option<&AwsApiGatewayRestApiDetails>

Provides information about a REST API in version 1 of Amazon API Gateway.

Source

pub fn aws_cloud_trail_trail(&self) -> Option<&AwsCloudTrailTrailDetails>

Provides details about a CloudTrail trail.

Source

pub fn aws_ssm_patch_compliance(&self) -> Option<&AwsSsmPatchComplianceDetails>

Provides information about the state of a patch on an instance based on the patch baseline that was used to patch the instance.

Source

pub fn aws_certificate_manager_certificate( &self, ) -> Option<&AwsCertificateManagerCertificateDetails>

Provides details about an Certificate Manager certificate.

Source

pub fn aws_redshift_cluster(&self) -> Option<&AwsRedshiftClusterDetails>

Contains details about an Amazon Redshift cluster.

Source

pub fn aws_elb_load_balancer(&self) -> Option<&AwsElbLoadBalancerDetails>

Contains details about a Classic Load Balancer.

Source

pub fn aws_iam_group(&self) -> Option<&AwsIamGroupDetails>

Contains details about an IAM group.

Source

pub fn aws_iam_role(&self) -> Option<&AwsIamRoleDetails>

Details about an IAM role.

Source

pub fn aws_kms_key(&self) -> Option<&AwsKmsKeyDetails>

Details about an KMS key.

Source

pub fn aws_lambda_function(&self) -> Option<&AwsLambdaFunctionDetails>

Details about a Lambda function.

Source

pub fn aws_lambda_layer_version(&self) -> Option<&AwsLambdaLayerVersionDetails>

Details for a Lambda layer version.

Source

pub fn aws_rds_db_instance(&self) -> Option<&AwsRdsDbInstanceDetails>

Details about an Amazon RDS database instance.

Source

pub fn aws_sns_topic(&self) -> Option<&AwsSnsTopicDetails>

Details about an SNS topic.

Source

pub fn aws_sqs_queue(&self) -> Option<&AwsSqsQueueDetails>

Details about an SQS queue.

Source

pub fn aws_waf_web_acl(&self) -> Option<&AwsWafWebAclDetails>

Details for an WAF web ACL.

Source

pub fn aws_rds_db_snapshot(&self) -> Option<&AwsRdsDbSnapshotDetails>

Details about an Amazon RDS database snapshot.

Source

pub fn aws_rds_db_cluster_snapshot( &self, ) -> Option<&AwsRdsDbClusterSnapshotDetails>

Details about an Amazon RDS database cluster snapshot.

Source

pub fn aws_rds_db_cluster(&self) -> Option<&AwsRdsDbClusterDetails>

Details about an Amazon RDS database cluster.

Source

pub fn aws_ecs_cluster(&self) -> Option<&AwsEcsClusterDetails>

Details about an Amazon ECS cluster.

Source

pub fn aws_ecs_container(&self) -> Option<&AwsEcsContainerDetails>

Provides information about a Docker container that's part of a task.

Source

pub fn aws_ecs_task_definition(&self) -> Option<&AwsEcsTaskDefinitionDetails>

Details about a task definition. A task definition describes the container and volume definitions of an Amazon Elastic Container Service task.

Source

pub fn container(&self) -> Option<&ContainerDetails>

Details about a container resource related to a finding.

Source

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

Details about a resource that are not available in a type-specific details object. Use the Other object in the following cases.

  • The type-specific object does not contain all of the fields that you want to populate. In this case, first use the type-specific object to populate those fields. Use the Other object to populate the fields that are missing from the type-specific object.

  • The resource type does not have a corresponding object. This includes resources for which the type is Other.

Source

pub fn aws_rds_event_subscription( &self, ) -> Option<&AwsRdsEventSubscriptionDetails>

Details about an RDS event notification subscription.

Source

pub fn aws_ecs_service(&self) -> Option<&AwsEcsServiceDetails>

Details about a service within an ECS cluster.

Source

pub fn aws_auto_scaling_launch_configuration( &self, ) -> Option<&AwsAutoScalingLaunchConfigurationDetails>

Provides details about a launch configuration.

Source

pub fn aws_ec2_vpn_connection(&self) -> Option<&AwsEc2VpnConnectionDetails>

Details about an Amazon EC2 VPN connection.

Source

pub fn aws_ecr_container_image(&self) -> Option<&AwsEcrContainerImageDetails>

Information about an Amazon ECR image.

Source

pub fn aws_open_search_service_domain( &self, ) -> Option<&AwsOpenSearchServiceDomainDetails>

Details about an Amazon OpenSearch Service domain.

Source

pub fn aws_ec2_vpc_endpoint_service( &self, ) -> Option<&AwsEc2VpcEndpointServiceDetails>

Details about the service configuration for a VPC endpoint service.

Source

pub fn aws_xray_encryption_config( &self, ) -> Option<&AwsXrayEncryptionConfigDetails>

Information about the encryption configuration for X-Ray.

Source

pub fn aws_waf_rate_based_rule(&self) -> Option<&AwsWafRateBasedRuleDetails>

Details about a rate-based rule for global resources.

Source

pub fn aws_waf_regional_rate_based_rule( &self, ) -> Option<&AwsWafRegionalRateBasedRuleDetails>

Details about a rate-based rule for Regional resources.

Source

pub fn aws_ecr_repository(&self) -> Option<&AwsEcrRepositoryDetails>

Information about an Amazon Elastic Container Registry repository.

Source

pub fn aws_eks_cluster(&self) -> Option<&AwsEksClusterDetails>

Details about an Amazon EKS cluster.

Source

pub fn aws_network_firewall_firewall_policy( &self, ) -> Option<&AwsNetworkFirewallFirewallPolicyDetails>

Details about an Network Firewall firewall policy.

Source

pub fn aws_network_firewall_firewall( &self, ) -> Option<&AwsNetworkFirewallFirewallDetails>

Details about an Network Firewall firewall.

Source

pub fn aws_network_firewall_rule_group( &self, ) -> Option<&AwsNetworkFirewallRuleGroupDetails>

Details about an Network Firewall rule group.

Source

pub fn aws_rds_db_security_group(&self) -> Option<&AwsRdsDbSecurityGroupDetails>

Details about an Amazon RDS DB security group.

Source

pub fn aws_kinesis_stream(&self) -> Option<&AwsKinesisStreamDetails>

Details about an Amazon Kinesis data stream.

Source

pub fn aws_ec2_transit_gateway(&self) -> Option<&AwsEc2TransitGatewayDetails>

Details about an Amazon EC2 transit gateway that interconnects your virtual private clouds (VPC) and on-premises networks.

Source

pub fn aws_efs_access_point(&self) -> Option<&AwsEfsAccessPointDetails>

Details about an Amazon EFS access point. An access point is an application-specific view into an EFS file system that applies an operating system user and group, and a file system path, to any file system request made through the access point.

Source

pub fn aws_cloud_formation_stack( &self, ) -> Option<&AwsCloudFormationStackDetails>

Details about an CloudFormation stack. A stack is a collection of Amazon Web Services resources that you can manage as a single unit.

Source

pub fn aws_cloud_watch_alarm(&self) -> Option<&AwsCloudWatchAlarmDetails>

Details about an Amazon CloudWatch alarm. An alarm allows you to monitor and receive alerts about your Amazon Web Services resources and applications across multiple Regions.

Source

pub fn aws_ec2_vpc_peering_connection( &self, ) -> Option<&AwsEc2VpcPeeringConnectionDetails>

Details about an Amazon EC2 VPC peering connection. A VPC peering connection is a networking connection between two VPCs that enables you to route traffic between them privately.

Source

pub fn aws_waf_regional_rule_group( &self, ) -> Option<&AwsWafRegionalRuleGroupDetails>

Details about an WAF rule group for Regional resources.

Source

pub fn aws_waf_regional_rule(&self) -> Option<&AwsWafRegionalRuleDetails>

Details about an WAF rule for Regional resources.

Source

pub fn aws_waf_regional_web_acl(&self) -> Option<&AwsWafRegionalWebAclDetails>

Details about an WAF web access control list (web ACL) for Regional resources.

Source

pub fn aws_waf_rule(&self) -> Option<&AwsWafRuleDetails>

Details about an WAF rule for global resources.

Source

pub fn aws_waf_rule_group(&self) -> Option<&AwsWafRuleGroupDetails>

Details about an WAF rule group for global resources.

Source

pub fn aws_ecs_task(&self) -> Option<&AwsEcsTaskDetails>

Details about a task in a cluster.

Source

pub fn aws_backup_backup_vault(&self) -> Option<&AwsBackupBackupVaultDetails>

Provides details about an Backup backup vault.

Source

pub fn aws_backup_backup_plan(&self) -> Option<&AwsBackupBackupPlanDetails>

Provides details about an Backup backup plan.

Source

pub fn aws_backup_recovery_point( &self, ) -> Option<&AwsBackupRecoveryPointDetails>

Provides details about an Backup backup, or recovery point.

Source

pub fn aws_ec2_launch_template(&self) -> Option<&AwsEc2LaunchTemplateDetails>

Specifies the properties for creating an Amazon Elastic Compute Cloud (Amazon EC2) launch template.

Source

pub fn aws_sage_maker_notebook_instance( &self, ) -> Option<&AwsSageMakerNotebookInstanceDetails>

Provides details about an Amazon SageMaker AI notebook instance.

Source

pub fn aws_wafv2_web_acl(&self) -> Option<&AwsWafv2WebAclDetails>

Details about an WAFv2 web Access Control List (ACL).

Source

pub fn aws_wafv2_rule_group(&self) -> Option<&AwsWafv2RuleGroupDetails>

Details about an WAFv2 rule group.

Source

pub fn aws_ec2_route_table(&self) -> Option<&AwsEc2RouteTableDetails>

Provides details about a route table. A route table contains a set of rules, called routes, that determine where to direct network traffic from your subnet or gateway.

Source

pub fn aws_amazon_mq_broker(&self) -> Option<&AwsAmazonMqBrokerDetails>

Provides details about AppSync message broker. A message broker allows software applications and components to communicate using various programming languages, operating systems, and formal messaging protocols.

Source

pub fn aws_app_sync_graph_ql_api(&self) -> Option<&AwsAppSyncGraphQlApiDetails>

Provides details about an AppSync Graph QL API, which lets you query multiple databases, microservices, and APIs from a single GraphQL endpoint.

Source

pub fn aws_event_schemas_registry( &self, ) -> Option<&AwsEventSchemasRegistryDetails>

A schema defines the structure of events that are sent to Amazon EventBridge. Schema registries are containers for schemas. They collect and organize schemas so that your schemas are in logical groups.

Source

pub fn aws_guard_duty_detector(&self) -> Option<&AwsGuardDutyDetectorDetails>

Provides details about an Amazon GuardDuty detector. A detector is an object that represents the GuardDuty service. A detector is required for GuardDuty to become operational.

Source

pub fn aws_step_function_state_machine( &self, ) -> Option<&AwsStepFunctionStateMachineDetails>

Provides details about an Step Functions state machine, which is a workflow consisting of a series of event-driven steps.

Source

pub fn aws_athena_work_group(&self) -> Option<&AwsAthenaWorkGroupDetails>

Provides information about an Amazon Athena workgroup. A workgroup helps you separate users, teams, applications, or workloads. It also helps you set limits on data processing and track costs.

Source

pub fn aws_events_eventbus(&self) -> Option<&AwsEventsEventbusDetails>

Provides details about Amazon EventBridge event bus for an endpoint. An event bus is a router that receives events and delivers them to zero or more destinations, or targets.

Source

pub fn aws_dms_endpoint(&self) -> Option<&AwsDmsEndpointDetails>

Provides details about an Database Migration Service (DMS) endpoint. An endpoint provides connection, data store type, and location information about your data store.

Source

pub fn aws_events_endpoint(&self) -> Option<&AwsEventsEndpointDetails>

Provides details about an Amazon EventBridge global endpoint. The endpoint can improve your application’s availability by making it Regional-fault tolerant.

Source

pub fn aws_dms_replication_task(&self) -> Option<&AwsDmsReplicationTaskDetails>

Provides details about an DMS replication task. A replication task moves a set of data from the source endpoint to the target endpoint.

Source

pub fn aws_dms_replication_instance( &self, ) -> Option<&AwsDmsReplicationInstanceDetails>

Provides details about an DMS replication instance. DMS uses a replication instance to connect to your source data store, read the source data, and format the data for consumption by the target data store.

Source

pub fn aws_route53_hosted_zone(&self) -> Option<&AwsRoute53HostedZoneDetails>

Provides details about an Amazon Route 53 hosted zone, including the four name servers assigned to the hosted zone. A hosted zone represents a collection of records that can be managed together, belonging to a single parent domain name.

Source

pub fn aws_msk_cluster(&self) -> Option<&AwsMskClusterDetails>

Provides details about an Amazon Managed Streaming for Apache Kafka (Amazon MSK) cluster.

Source

pub fn aws_s3_access_point(&self) -> Option<&AwsS3AccessPointDetails>

Provides details about an Amazon Simple Storage Service (Amazon S3) access point. S3 access points are named network endpoints that are attached to S3 buckets that you can use to perform S3 object operations.

Source

pub fn aws_ec2_client_vpn_endpoint( &self, ) -> Option<&AwsEc2ClientVpnEndpointDetails>

Provides details about an Client VPN endpoint. A Client VPN endpoint is the resource that you create and configure to enable and manage client VPN sessions. It's the termination point for all client VPN sessions.

Source§

impl ResourceDetails

Source

pub fn builder() -> ResourceDetailsBuilder

Creates a new builder-style object to manufacture ResourceDetails.

Trait Implementations§

Source§

impl Clone for ResourceDetails

Source§

fn clone(&self) -> ResourceDetails

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ResourceDetails

Source§

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

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

impl PartialEq for ResourceDetails

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for ResourceDetails

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

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

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

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

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

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

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

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

Source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
Source§

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

Source§

fn fg(&self, value: Color) -> Painted<&T>

Returns a styled value derived from self with the foreground set to value.

This method should be used rarely. Instead, prefer to use color-specific builder methods like red() and green(), which have the same functionality but are pithier.

§Example

Set foreground color to white using fg():

use yansi::{Paint, Color};

painted.fg(Color::White);

Set foreground color to white using white().

use yansi::Paint;

painted.white();
Source§

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

Returns self with the fg() set to [Color :: Primary].

§Example
println!("{}", value.primary());
Source§

fn fixed(&self, color: u8) -> Painted<&T>

Returns self with the fg() set to [Color :: Fixed].

§Example
println!("{}", value.fixed(color));
Source§

fn rgb(&self, r: u8, g: u8, b: u8) -> Painted<&T>

Returns self with the fg() set to [Color :: Rgb].

§Example
println!("{}", value.rgb(r, g, b));
Source§

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

Returns self with the fg() set to [Color :: Black].

§Example
println!("{}", value.black());
Source§

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

Returns self with the fg() set to [Color :: Red].

§Example
println!("{}", value.red());
Source§

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

Returns self with the fg() set to [Color :: Green].

§Example
println!("{}", value.green());
Source§

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

Returns self with the fg() set to [Color :: Yellow].

§Example
println!("{}", value.yellow());
Source§

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

Returns self with the fg() set to [Color :: Blue].

§Example
println!("{}", value.blue());
Source§

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

Returns self with the fg() set to [Color :: Magenta].

§Example
println!("{}", value.magenta());
Source§

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

Returns self with the fg() set to [Color :: Cyan].

§Example
println!("{}", value.cyan());
Source§

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

Returns self with the fg() set to [Color :: White].

§Example
println!("{}", value.white());
Source§

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

Returns self with the fg() set to [Color :: BrightBlack].

§Example
println!("{}", value.bright_black());
Source§

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

Returns self with the fg() set to [Color :: BrightRed].

§Example
println!("{}", value.bright_red());
Source§

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

Returns self with the fg() set to [Color :: BrightGreen].

§Example
println!("{}", value.bright_green());
Source§

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

Returns self with the fg() set to [Color :: BrightYellow].

§Example
println!("{}", value.bright_yellow());
Source§

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

Returns self with the fg() set to [Color :: BrightBlue].

§Example
println!("{}", value.bright_blue());
Source§

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

Returns self with the fg() set to [Color :: BrightMagenta].

§Example
println!("{}", value.bright_magenta());
Source§

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

Returns self with the fg() set to [Color :: BrightCyan].

§Example
println!("{}", value.bright_cyan());
Source§

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

Returns self with the fg() set to [Color :: BrightWhite].

§Example
println!("{}", value.bright_white());
Source§

fn bg(&self, value: Color) -> Painted<&T>

Returns a styled value derived from self with the background set to value.

This method should be used rarely. Instead, prefer to use color-specific builder methods like on_red() and on_green(), which have the same functionality but are pithier.

§Example

Set background color to red using fg():

use yansi::{Paint, Color};

painted.bg(Color::Red);

Set background color to red using on_red().

use yansi::Paint;

painted.on_red();
Source§

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

Returns self with the bg() set to [Color :: Primary].

§Example
println!("{}", value.on_primary());
Source§

fn on_fixed(&self, color: u8) -> Painted<&T>

Returns self with the bg() set to [Color :: Fixed].

§Example
println!("{}", value.on_fixed(color));
Source§

fn on_rgb(&self, r: u8, g: u8, b: u8) -> Painted<&T>

Returns self with the bg() set to [Color :: Rgb].

§Example
println!("{}", value.on_rgb(r, g, b));
Source§

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

Returns self with the bg() set to [Color :: Black].

§Example
println!("{}", value.on_black());
Source§

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

Returns self with the bg() set to [Color :: Red].

§Example
println!("{}", value.on_red());
Source§

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

Returns self with the bg() set to [Color :: Green].

§Example
println!("{}", value.on_green());
Source§

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

Returns self with the bg() set to [Color :: Yellow].

§Example
println!("{}", value.on_yellow());
Source§

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

Returns self with the bg() set to [Color :: Blue].

§Example
println!("{}", value.on_blue());
Source§

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

Returns self with the bg() set to [Color :: Magenta].

§Example
println!("{}", value.on_magenta());
Source§

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

Returns self with the bg() set to [Color :: Cyan].

§Example
println!("{}", value.on_cyan());
Source§

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

Returns self with the bg() set to [Color :: White].

§Example
println!("{}", value.on_white());
Source§

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

Returns self with the bg() set to [Color :: BrightBlack].

§Example
println!("{}", value.on_bright_black());
Source§

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

Returns self with the bg() set to [Color :: BrightRed].

§Example
println!("{}", value.on_bright_red());
Source§

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

Returns self with the bg() set to [Color :: BrightGreen].

§Example
println!("{}", value.on_bright_green());
Source§

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

Returns self with the bg() set to [Color :: BrightYellow].

§Example
println!("{}", value.on_bright_yellow());
Source§

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

Returns self with the bg() set to [Color :: BrightBlue].

§Example
println!("{}", value.on_bright_blue());
Source§

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

Returns self with the bg() set to [Color :: BrightMagenta].

§Example
println!("{}", value.on_bright_magenta());
Source§

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

Returns self with the bg() set to [Color :: BrightCyan].

§Example
println!("{}", value.on_bright_cyan());
Source§

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

Returns self with the bg() set to [Color :: BrightWhite].

§Example
println!("{}", value.on_bright_white());
Source§

fn attr(&self, value: Attribute) -> Painted<&T>

Enables the styling Attribute value.

This method should be used rarely. Instead, prefer to use attribute-specific builder methods like bold() and underline(), which have the same functionality but are pithier.

§Example

Make text bold using attr():

use yansi::{Paint, Attribute};

painted.attr(Attribute::Bold);

Make text bold using using bold().

use yansi::Paint;

painted.bold();
Source§

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

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

§Example
println!("{}", value.bold());
Source§

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

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

§Example
println!("{}", value.dim());
Source§

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

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

§Example
println!("{}", value.italic());
Source§

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

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

§Example
println!("{}", value.underline());

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

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

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

§Example
println!("{}", value.rapid_blink());
Source§

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

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

§Example
println!("{}", value.invert());
Source§

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

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

§Example
println!("{}", value.conceal());
Source§

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

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

§Example
println!("{}", value.strike());
Source§

fn quirk(&self, value: Quirk) -> Painted<&T>

Enables the yansi Quirk value.

This method should be used rarely. Instead, prefer to use quirk-specific builder methods like mask() and wrap(), which have the same functionality but are pithier.

§Example

Enable wrapping using .quirk():

use yansi::{Paint, Quirk};

painted.quirk(Quirk::Wrap);

Enable wrapping using wrap().

use yansi::Paint;

painted.wrap();
Source§

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

Returns self with the quirk() set to [Quirk :: Mask].

§Example
println!("{}", value.mask());
Source§

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

Returns self with the quirk() set to [Quirk :: Wrap].

§Example
println!("{}", value.wrap());
Source§

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

Returns self with the quirk() set to [Quirk :: Linger].

§Example
println!("{}", value.linger());
Source§

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

👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear(). The clear() method will be removed in a future release.

Returns self with the quirk() set to [Quirk :: Clear].

§Example
println!("{}", value.clear());
Source§

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

Returns self with the quirk() set to [Quirk :: Resetting].

§Example
println!("{}", value.resetting());
Source§

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

Returns self with the quirk() set to [Quirk :: Bright].

§Example
println!("{}", value.bright());
Source§

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

Returns self with the quirk() set to [Quirk :: OnBright].

§Example
println!("{}", value.on_bright());
Source§

fn whenever(&self, value: Condition) -> Painted<&T>

Conditionally enable styling based on whether the Condition value applies. Replaces any previous condition.

See the crate level docs for more details.

§Example

Enable styling painted only when both stdout and stderr are TTYs:

use yansi::{Paint, Condition};

painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);
Source§

fn new(self) -> Painted<Self>
where Self: Sized,

Create a new Painted with a default Style. Read more
Source§

fn paint<S>(&self, style: S) -> Painted<&Self>
where S: Into<Style>,

Apply a style wholesale to self. Any previous style is replaced. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

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

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,