Struct ValidatePolicyFinding

#[non_exhaustive]
pub struct ValidatePolicyFinding {
    pub finding_details: String,
    pub finding_type: ValidatePolicyFindingType,
    pub issue_code: String,
    pub learn_more_link: String,
    pub locations: Vec<Location>,
}

A finding in a policy. Each finding is an actionable recommendation that can be used to improve the policy.

Fields (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.

finding_details: String

A localized message that explains the finding and provides guidance on how to address it.

finding_type: ValidatePolicyFindingType

The impact of the finding.

Security warnings report when the policy allows access that we consider overly permissive.

Errors report when a part of the policy is not functional.

Warnings report non-security issues when a policy does not conform to policy writing best practices.

Suggestions recommend stylistic improvements in the policy that do not impact access.

issue_code: String

The issue code provides an identifier of the issue associated with this finding.

learn_more_link: String

A link to additional documentation about the type of finding.

locations: Vec<Location>

The list of locations in the policy document that are related to the finding. The issue code provides a summary of an issue identified by the finding.

Implementations

impl ValidatePolicyFinding

pub fn finding_details(&self) -> &str

A localized message that explains the finding and provides guidance on how to address it.

pub fn finding_type(&self) -> &ValidatePolicyFindingType

The impact of the finding.

Security warnings report when the policy allows access that we consider overly permissive.

Errors report when a part of the policy is not functional.

Warnings report non-security issues when a policy does not conform to policy writing best practices.

Suggestions recommend stylistic improvements in the policy that do not impact access.

pub fn issue_code(&self) -> &str

The issue code provides an identifier of the issue associated with this finding.

pub fn learn_more_link(&self) -> &str

A link to additional documentation about the type of finding.

pub fn locations(&self) -> &[Location]

The list of locations in the policy document that are related to the finding. The issue code provides a summary of an issue identified by the finding.

impl ValidatePolicyFinding

pub fn builder() -> ValidatePolicyFindingBuilder

Creates a new builder-style object to manufacture ValidatePolicyFinding.

Trait Implementations

impl Clone for ValidatePolicyFinding

fn clone(&self) -> ValidatePolicyFinding

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ValidatePolicyFinding

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

Formats the value using the given formatter.

impl PartialEq for ValidatePolicyFinding

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

Tests for self and other values to be equal, and is used by ==.

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 ValidatePolicyFinding