AutomationRulesFindingFilters

aws_sdk_securityhub::types

Struct AutomationRulesFindingFilters

#[non_exhaustive]
pub struct AutomationRulesFindingFilters {Show 38 fields
    pub product_arn: Option<Vec<StringFilter>>,
    pub aws_account_id: Option<Vec<StringFilter>>,
    pub id: Option<Vec<StringFilter>>,
    pub generator_id: Option<Vec<StringFilter>>,
    pub type: Option<Vec<StringFilter>>,
    pub first_observed_at: Option<Vec<DateFilter>>,
    pub last_observed_at: Option<Vec<DateFilter>>,
    pub created_at: Option<Vec<DateFilter>>,
    pub updated_at: Option<Vec<DateFilter>>,
    pub confidence: Option<Vec<NumberFilter>>,
    pub criticality: Option<Vec<NumberFilter>>,
    pub title: Option<Vec<StringFilter>>,
    pub description: Option<Vec<StringFilter>>,
    pub source_url: Option<Vec<StringFilter>>,
    pub product_name: Option<Vec<StringFilter>>,
    pub company_name: Option<Vec<StringFilter>>,
    pub severity_label: Option<Vec<StringFilter>>,
    pub resource_type: Option<Vec<StringFilter>>,
    pub resource_id: Option<Vec<StringFilter>>,
    pub resource_partition: Option<Vec<StringFilter>>,
    pub resource_region: Option<Vec<StringFilter>>,
    pub resource_tags: Option<Vec<MapFilter>>,
    pub resource_details_other: Option<Vec<MapFilter>>,
    pub compliance_status: Option<Vec<StringFilter>>,
    pub compliance_security_control_id: Option<Vec<StringFilter>>,
    pub compliance_associated_standards_id: Option<Vec<StringFilter>>,
    pub verification_state: Option<Vec<StringFilter>>,
    pub workflow_status: Option<Vec<StringFilter>>,
    pub record_state: Option<Vec<StringFilter>>,
    pub related_findings_product_arn: Option<Vec<StringFilter>>,
    pub related_findings_id: Option<Vec<StringFilter>>,
    pub note_text: Option<Vec<StringFilter>>,
    pub note_updated_at: Option<Vec<DateFilter>>,
    pub note_updated_by: Option<Vec<StringFilter>>,
    pub user_defined_fields: Option<Vec<MapFilter>>,
    pub resource_application_arn: Option<Vec<StringFilter>>,
    pub resource_application_name: Option<Vec<StringFilter>>,
    pub aws_account_name: Option<Vec<StringFilter>>,
}

Expand description

The criteria that determine which findings a rule applies to.

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.

§product_arn: Option<Vec<StringFilter>>

The Amazon Resource Name (ARN) for a third-party product that generated a finding in Security Hub.

Array Members: Minimum number of 1 item. Maximum number of 20 items.

§aws_account_id: Option<Vec<StringFilter>>

The Amazon Web Services account ID in which a finding was generated.

Array Members: Minimum number of 1 item. Maximum number of 100 items.

§id: Option<Vec<StringFilter>>

The product-specific identifier for a finding.

Array Members: Minimum number of 1 item. Maximum number of 20 items.

§generator_id: Option<Vec<StringFilter>>

The identifier for the solution-specific component that generated a finding.

Array Members: Minimum number of 1 item. Maximum number of 100 items.

§type: Option<Vec<StringFilter>>

One or more finding types in the format of namespace/category/classifier that classify a finding. For a list of namespaces, classifiers, and categories, see Types taxonomy for ASFF in the Security Hub User Guide.

Array Members: Minimum number of 1 item. Maximum number of 20 items.

§first_observed_at: Option<Vec<DateFilter>>

A timestamp that indicates when the potential security issue captured by a finding was first observed by the security findings product.

For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.

Array Members: Minimum number of 1 item. Maximum number of 20 items.

§last_observed_at: Option<Vec<DateFilter>>

A timestamp that indicates when the security findings provider most recently observed a change in the resource that is involved in the finding.

For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.

Array Members: Minimum number of 1 item. Maximum number of 20 items.

§created_at: Option<Vec<DateFilter>>

A timestamp that indicates when this finding record was created.

For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.

Array Members: Minimum number of 1 item. Maximum number of 20 items.

§updated_at: Option<Vec<DateFilter>>

A timestamp that indicates when the finding record was most recently updated.

For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.

Array Members: Minimum number of 1 item. Maximum number of 20 items.

§confidence: Option<Vec<NumberFilter>>

The likelihood that a finding accurately identifies the behavior or issue that it was intended to identify. Confidence is scored on a 0–100 basis using a ratio scale. A value of 0 means 0 percent confidence, and a value of 100 means 100 percent confidence. For example, a data exfiltration detection based on a statistical deviation of network traffic has low confidence because an actual exfiltration hasn't been verified. For more information, see Confidence in the Security Hub User Guide.

Array Members: Minimum number of 1 item. Maximum number of 20 items.

§criticality: Option<Vec<NumberFilter>>

The level of importance that is assigned to the resources that are associated with a finding. Criticality is scored on a 0–100 basis, using a ratio scale that supports only full integers. A score of 0 means that the underlying resources have no criticality, and a score of 100 is reserved for the most critical resources. For more information, see Criticality in the Security Hub User Guide.

Array Members: Minimum number of 1 item. Maximum number of 20 items.

§title: Option<Vec<StringFilter>>

A finding's title.

Array Members: Minimum number of 1 item. Maximum number of 100 items.

§description: Option<Vec<StringFilter>>

A finding's description.

Array Members: Minimum number of 1 item. Maximum number of 20 items.

§source_url: Option<Vec<StringFilter>>

Provides a URL that links to a page about the current finding in the finding product.

Array Members: Minimum number of 1 item. Maximum number of 20 items.

§product_name: Option<Vec<StringFilter>>

Provides the name of the product that generated the finding. For control-based findings, the product name is Security Hub.

Array Members: Minimum number of 1 item. Maximum number of 20 items.

§company_name: Option<Vec<StringFilter>>

The name of the company for the product that generated the finding. For control-based findings, the company is Amazon Web Services.

Array Members: Minimum number of 1 item. Maximum number of 20 items.

§severity_label: Option<Vec<StringFilter>>

The severity value of the finding.

Array Members: Minimum number of 1 item. Maximum number of 20 items.

§resource_type: Option<Vec<StringFilter>>

The type of resource that the finding pertains to.

Array Members: Minimum number of 1 item. Maximum number of 20 items.

§resource_id: Option<Vec<StringFilter>>

The identifier for the given resource type. For Amazon Web Services resources that are identified by Amazon Resource Names (ARNs), this is the ARN. For Amazon Web Services resources that lack ARNs, this is the identifier as defined by the Amazon Web Services service that created the resource. For non-Amazon Web Services resources, this is a unique identifier that is associated with the resource.

Array Members: Minimum number of 1 item. Maximum number of 100 items.

§resource_partition: Option<Vec<StringFilter>>

The partition in which the resource that the finding pertains to is located. A partition is a group of Amazon Web Services Regions. Each Amazon Web Services account is scoped to one partition.

Array Members: Minimum number of 1 item. Maximum number of 20 items.

§resource_region: Option<Vec<StringFilter>>

The Amazon Web Services Region where the resource that a finding pertains to is located.

Array Members: Minimum number of 1 item. Maximum number of 20 items.

§resource_tags: Option<Vec<MapFilter>>

A list of Amazon Web Services tags associated with a resource at the time the finding was processed.

Array Members: Minimum number of 1 item. Maximum number of 20 items.

§resource_details_other: Option<Vec<MapFilter>>

Custom fields and values about the resource that a finding pertains to.

Array Members: Minimum number of 1 item. Maximum number of 20 items.

§compliance_status: Option<Vec<StringFilter>>

The result of a security check. This field is only used for findings generated from controls.

Array Members: Minimum number of 1 item. Maximum number of 20 items.

§compliance_security_control_id: Option<Vec<StringFilter>>

The security control ID for which a finding was generated. Security control IDs are the same across standards.

Array Members: Minimum number of 1 item. Maximum number of 20 items.

§compliance_associated_standards_id: Option<Vec<StringFilter>>

The unique identifier of a standard in which a control is enabled. This field consists of the resource portion of the Amazon Resource Name (ARN) returned for a standard in the DescribeStandards API response.

Array Members: Minimum number of 1 item. Maximum number of 20 items.

§verification_state: Option<Vec<StringFilter>>

Provides the veracity of a finding.

Array Members: Minimum number of 1 item. Maximum number of 20 items.

§workflow_status: Option<Vec<StringFilter>>

Provides information about the status of the investigation into a finding.

Array Members: Minimum number of 1 item. Maximum number of 20 items.

§record_state: Option<Vec<StringFilter>>

Provides the current state of a finding.

Array Members: Minimum number of 1 item. Maximum number of 20 items.

§related_findings_product_arn: Option<Vec<StringFilter>>

The ARN for the product that generated a related finding.

Array Members: Minimum number of 1 item. Maximum number of 20 items.

§related_findings_id: Option<Vec<StringFilter>>

The product-generated identifier for a related finding.

Array Members: Minimum number of 1 item. Maximum number of 20 items.

§note_text: Option<Vec<StringFilter>>

The text of a user-defined note that's added to a finding.

Array Members: Minimum number of 1 item. Maximum number of 20 items.

§note_updated_at: Option<Vec<DateFilter>>

The timestamp of when the note was updated.

For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.

Array Members: Minimum number of 1 item. Maximum number of 20 items.

§note_updated_by: Option<Vec<StringFilter>>

The principal that created a note.

Array Members: Minimum number of 1 item. Maximum number of 20 items.

§user_defined_fields: Option<Vec<MapFilter>>

A list of user-defined name and value string pairs added to a finding.

Array Members: Minimum number of 1 item. Maximum number of 20 items.

§resource_application_arn: Option<Vec<StringFilter>>

The Amazon Resource Name (ARN) of the application that is related to a finding.

Array Members: Minimum number of 1 item. Maximum number of 20 items.

§resource_application_name: Option<Vec<StringFilter>>

The name of the application that is related to a finding.

Array Members: Minimum number of 1 item. Maximum number of 20 items.

§aws_account_name: Option<Vec<StringFilter>>

The name of the Amazon Web Services account in which a finding was generated.

Array Members: Minimum number of 1 item. Maximum number of 20 items.

Implementations§

impl AutomationRulesFindingFilters

pub fn product_arn(&self) -> &[StringFilter]

The Amazon Resource Name (ARN) for a third-party product that generated a finding in Security Hub.

Array Members: Minimum number of 1 item. Maximum number of 20 items.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .product_arn.is_none().

pub fn aws_account_id(&self) -> &[StringFilter]

The Amazon Web Services account ID in which a finding was generated.

Array Members: Minimum number of 1 item. Maximum number of 100 items.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .aws_account_id.is_none().

pub fn id(&self) -> &[StringFilter]

The product-specific identifier for a finding.

Array Members: Minimum number of 1 item. Maximum number of 20 items.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .id.is_none().

pub fn generator_id(&self) -> &[StringFilter]

The identifier for the solution-specific component that generated a finding.

Array Members: Minimum number of 1 item. Maximum number of 100 items.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .generator_id.is_none().

pub fn type(&self) -> &[StringFilter]

One or more finding types in the format of namespace/category/classifier that classify a finding. For a list of namespaces, classifiers, and categories, see Types taxonomy for ASFF in the Security Hub User Guide.

Array Members: Minimum number of 1 item. Maximum number of 20 items.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .r#type.is_none().

pub fn first_observed_at(&self) -> &[DateFilter]

A timestamp that indicates when the potential security issue captured by a finding was first observed by the security findings product.

For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.

Array Members: Minimum number of 1 item. Maximum number of 20 items.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .first_observed_at.is_none().

pub fn last_observed_at(&self) -> &[DateFilter]

A timestamp that indicates when the security findings provider most recently observed a change in the resource that is involved in the finding.

For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.

Array Members: Minimum number of 1 item. Maximum number of 20 items.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .last_observed_at.is_none().

pub fn created_at(&self) -> &[DateFilter]

A timestamp that indicates when this finding record was created.

For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.

Array Members: Minimum number of 1 item. Maximum number of 20 items.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .created_at.is_none().

pub fn updated_at(&self) -> &[DateFilter]

A timestamp that indicates when the finding record was most recently updated.

For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.

Array Members: Minimum number of 1 item. Maximum number of 20 items.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .updated_at.is_none().

pub fn confidence(&self) -> &[NumberFilter]

The likelihood that a finding accurately identifies the behavior or issue that it was intended to identify. Confidence is scored on a 0–100 basis using a ratio scale. A value of 0 means 0 percent confidence, and a value of 100 means 100 percent confidence. For example, a data exfiltration detection based on a statistical deviation of network traffic has low confidence because an actual exfiltration hasn't been verified. For more information, see Confidence in the Security Hub User Guide.

Array Members: Minimum number of 1 item. Maximum number of 20 items.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .confidence.is_none().

pub fn criticality(&self) -> &[NumberFilter]

The level of importance that is assigned to the resources that are associated with a finding. Criticality is scored on a 0–100 basis, using a ratio scale that supports only full integers. A score of 0 means that the underlying resources have no criticality, and a score of 100 is reserved for the most critical resources. For more information, see Criticality in the Security Hub User Guide.

Array Members: Minimum number of 1 item. Maximum number of 20 items.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .criticality.is_none().

pub fn title(&self) -> &[StringFilter]

A finding's title.

Array Members: Minimum number of 1 item. Maximum number of 100 items.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .title.is_none().

pub fn description(&self) -> &[StringFilter]

A finding's description.

Array Members: Minimum number of 1 item. Maximum number of 20 items.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .description.is_none().

pub fn source_url(&self) -> &[StringFilter]

Provides a URL that links to a page about the current finding in the finding product.

Array Members: Minimum number of 1 item. Maximum number of 20 items.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .source_url.is_none().

pub fn product_name(&self) -> &[StringFilter]

Provides the name of the product that generated the finding. For control-based findings, the product name is Security Hub.

Array Members: Minimum number of 1 item. Maximum number of 20 items.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .product_name.is_none().

pub fn company_name(&self) -> &[StringFilter]

The name of the company for the product that generated the finding. For control-based findings, the company is Amazon Web Services.

Array Members: Minimum number of 1 item. Maximum number of 20 items.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .company_name.is_none().

pub fn severity_label(&self) -> &[StringFilter]

The severity value of the finding.

Array Members: Minimum number of 1 item. Maximum number of 20 items.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .severity_label.is_none().

pub fn resource_type(&self) -> &[StringFilter]

The type of resource that the finding pertains to.

Array Members: Minimum number of 1 item. Maximum number of 20 items.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .resource_type.is_none().

pub fn resource_id(&self) -> &[StringFilter]

The identifier for the given resource type. For Amazon Web Services resources that are identified by Amazon Resource Names (ARNs), this is the ARN. For Amazon Web Services resources that lack ARNs, this is the identifier as defined by the Amazon Web Services service that created the resource. For non-Amazon Web Services resources, this is a unique identifier that is associated with the resource.

Array Members: Minimum number of 1 item. Maximum number of 100 items.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .resource_id.is_none().

pub fn resource_partition(&self) -> &[StringFilter]

The partition in which the resource that the finding pertains to is located. A partition is a group of Amazon Web Services Regions. Each Amazon Web Services account is scoped to one partition.

Array Members: Minimum number of 1 item. Maximum number of 20 items.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .resource_partition.is_none().

pub fn resource_region(&self) -> &[StringFilter]

The Amazon Web Services Region where the resource that a finding pertains to is located.

Array Members: Minimum number of 1 item. Maximum number of 20 items.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .resource_region.is_none().

pub fn resource_tags(&self) -> &[MapFilter]

A list of Amazon Web Services tags associated with a resource at the time the finding was processed.

Array Members: Minimum number of 1 item. Maximum number of 20 items.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .resource_tags.is_none().

pub fn resource_details_other(&self) -> &[MapFilter]

Custom fields and values about the resource that a finding pertains to.

Array Members: Minimum number of 1 item. Maximum number of 20 items.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .resource_details_other.is_none().

pub fn compliance_status(&self) -> &[StringFilter]

The result of a security check. This field is only used for findings generated from controls.

Array Members: Minimum number of 1 item. Maximum number of 20 items.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .compliance_status.is_none().

pub fn compliance_security_control_id(&self) -> &[StringFilter]

The security control ID for which a finding was generated. Security control IDs are the same across standards.

Array Members: Minimum number of 1 item. Maximum number of 20 items.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .compliance_security_control_id.is_none().

pub fn compliance_associated_standards_id(&self) -> &[StringFilter]

The unique identifier of a standard in which a control is enabled. This field consists of the resource portion of the Amazon Resource Name (ARN) returned for a standard in the DescribeStandards API response.

Array Members: Minimum number of 1 item. Maximum number of 20 items.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .compliance_associated_standards_id.is_none().

pub fn verification_state(&self) -> &[StringFilter]

Provides the veracity of a finding.

Array Members: Minimum number of 1 item. Maximum number of 20 items.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .verification_state.is_none().

pub fn workflow_status(&self) -> &[StringFilter]

Provides information about the status of the investigation into a finding.

Array Members: Minimum number of 1 item. Maximum number of 20 items.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .workflow_status.is_none().

pub fn record_state(&self) -> &[StringFilter]

Provides the current state of a finding.

Array Members: Minimum number of 1 item. Maximum number of 20 items.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .record_state.is_none().

pub fn related_findings_product_arn(&self) -> &[StringFilter]

The ARN for the product that generated a related finding.

Array Members: Minimum number of 1 item. Maximum number of 20 items.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .related_findings_product_arn.is_none().

pub fn related_findings_id(&self) -> &[StringFilter]

The product-generated identifier for a related finding.

Array Members: Minimum number of 1 item. Maximum number of 20 items.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .related_findings_id.is_none().

pub fn note_text(&self) -> &[StringFilter]

The text of a user-defined note that's added to a finding.

Array Members: Minimum number of 1 item. Maximum number of 20 items.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .note_text.is_none().

pub fn note_updated_at(&self) -> &[DateFilter]

The timestamp of when the note was updated.

For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.

Array Members: Minimum number of 1 item. Maximum number of 20 items.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .note_updated_at.is_none().

pub fn note_updated_by(&self) -> &[StringFilter]

The principal that created a note.

Array Members: Minimum number of 1 item. Maximum number of 20 items.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .note_updated_by.is_none().

pub fn user_defined_fields(&self) -> &[MapFilter]

A list of user-defined name and value string pairs added to a finding.

Array Members: Minimum number of 1 item. Maximum number of 20 items.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .user_defined_fields.is_none().

pub fn resource_application_arn(&self) -> &[StringFilter]

The Amazon Resource Name (ARN) of the application that is related to a finding.

Array Members: Minimum number of 1 item. Maximum number of 20 items.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .resource_application_arn.is_none().

pub fn resource_application_name(&self) -> &[StringFilter]

The name of the application that is related to a finding.

Array Members: Minimum number of 1 item. Maximum number of 20 items.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .resource_application_name.is_none().

pub fn aws_account_name(&self) -> &[StringFilter]

The name of the Amazon Web Services account in which a finding was generated.

Array Members: Minimum number of 1 item. Maximum number of 20 items.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .aws_account_name.is_none().

impl AutomationRulesFindingFilters

pub fn builder() -> AutomationRulesFindingFiltersBuilder

Creates a new builder-style object to manufacture AutomationRulesFindingFilters.

Trait Implementations§

impl Clone for AutomationRulesFindingFilters

fn clone(&self) -> AutomationRulesFindingFilters

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

impl Debug for AutomationRulesFindingFilters

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

Formats the value using the given formatter. Read more

impl PartialEq for AutomationRulesFindingFilters

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

impl StructuralPartialEq for AutomationRulesFindingFilters

Auto Trait Implementations§

impl Freeze for AutomationRulesFindingFilters

impl RefUnwindSafe for AutomationRulesFindingFilters

impl Send for AutomationRulesFindingFilters

impl Sync for AutomationRulesFindingFilters

impl Unpin for AutomationRulesFindingFilters

impl UnwindSafe for AutomationRulesFindingFilters

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

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

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

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

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

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

fn in_current_span(self) -> Instrumented<Self>

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

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

fn into(self) -> U

Calls U::from(self).

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

impl<T> IntoEither for T

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

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

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

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.

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

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();

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

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

§Example

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

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

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

§Example

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

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));

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

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

§Example

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

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

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

§Example

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

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

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

§Example

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

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

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

§Example

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

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

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

§Example

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

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

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

§Example

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

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

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

§Example

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

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

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

§Example

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

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

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

§Example

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

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

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

§Example

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

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

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

§Example

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

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

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

§Example

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

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

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

§Example

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

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

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

§Example

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

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

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

§Example

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

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

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

§Example

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

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();

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

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

§Example

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

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

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

§Example

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

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));

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

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

§Example

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

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

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

§Example

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

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

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

§Example

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

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

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

§Example

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

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

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

§Example

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

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

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

§Example

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

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

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

§Example

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

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

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

§Example

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

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

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

§Example

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

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

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

§Example

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

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

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

§Example

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

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

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

§Example

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

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

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

§Example

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

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

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

§Example

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

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

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

§Example

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

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

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

§Example

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

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();

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

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

§Example

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

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

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

§Example

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

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

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

§Example

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

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

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

§Example

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

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

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

§Example

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

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

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

§Example

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

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

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

§Example

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

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

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

§Example

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

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

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

§Example

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

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();

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

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

§Example

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

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

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

§Example

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

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

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

§Example

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

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());

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

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

§Example

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

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

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

§Example

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

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

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

§Example

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

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);

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

Create a new Painted with a default Style. Read more

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

impl<T> Same for T

type Output = T

Should always be Self

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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

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