Struct cedar_policy::ValidationResult

pub struct ValidationResult<'a> { /* private fields */ }

Contains the result of policy validation. The result includes the list of issues found by validation and whether validation succeeds or fails. Validation succeeds if there are no fatal errors. There may still be non-fatal warnings present when validation passes.

Implementations

impl<'a> ValidationResult<'a>

pub fn validation_passed(&self) -> bool

True when validation passes. There are no errors, but there may be non-fatal warnings. Use ValidationResult::validation_passed_without_warnings to check that there are also no warnings.

pub fn validation_passed_without_warnings(&self) -> bool

True when validation passes (i.e., there are no errors) and there are additionally no non-fatal warnings.

pub fn validation_errors( &self ) -> impl Iterator<Item = &ValidationError<'static>>

Get an iterator over the errors found by the validator.

pub fn validation_warnings( &self ) -> impl Iterator<Item = &ValidationWarning<'static>>

Get an iterator over the warnings found by the validator.

Trait Implementations

impl<'a> Debug for ValidationResult<'a>

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

Formats the value using the given formatter.

impl<'a> Diagnostic for ValidationResult<'a>

fn related<'s>( &'s self ) -> Option<Box<dyn Iterator<Item = &'s dyn Diagnostic> + 's>>

Additional related Diagnostics.

fn severity(&self) -> Option<Severity>

Diagnostic severity. This may be used by ReportHandlers to change the display format of this diagnostic.

fn labels(&self) -> Option<Box<dyn Iterator<Item = LabeledSpan> + '_>>

Labels to apply to this Diagnostic’s Diagnostic::source_code

fn source_code(&self) -> Option<&dyn SourceCode>

Source code to apply this Diagnostic’s Diagnostic::labels to.

fn code<'s>(&'s self) -> Option<Box<dyn Display + 's>>

Unique diagnostic code that can be used to look up more information about this Diagnostic. Ideally also globally unique, and documented in the toplevel crate’s documentation for easy searching. Rust path format (foo::bar::baz) is recommended, but more classic codes like E0123 or enums will work just fine.

fn url<'s>(&'s self) -> Option<Box<dyn Display + 's>>

URL to visit for a more detailed explanation/help about this Diagnostic.

fn help<'s>(&'s self) -> Option<Box<dyn Display + 's>>

Additional help text related to this Diagnostic. Do you have any advice for the poor soul who’s just run into this issue?

fn diagnostic_source(&self) -> Option<&dyn Diagnostic>

The cause of the error.

impl<'a> Display for ValidationResult<'a>

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

Formats the value using the given formatter.

impl<'a> Error for ValidationResult<'a>

fn source(&self) -> Option<&(dyn Error + 'static)>

The lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type based access to context intended for error reports.

impl<'a> From<ValidationResult<'a>> for ValidationResult<'static>

fn from(r: ValidationResult<'a>) -> Self

Converts to this type from the input type.