Skip to main content

GuardRuleFile

Struct GuardRuleFile 

Source
pub struct GuardRuleFile { /* private fields */ }
Expand description

A parsed Guard rule file, ready to be evaluated against any template.

The Guard parser borrows from the source text, so the file keeps the text and re-parses it per evaluation; a syntax error is still caught once, here, at load time.

Implementations§

Source§

impl GuardRuleFile

Source

pub fn parse( name: impl Into<String>, source: impl Into<String>, ) -> Result<Self, String>

Parses source, reporting a syntax error with the file name, and records each declared rule’s name and first custom message.

Source

pub fn name(&self) -> &str

Source

pub fn pack(&self) -> &str

The pack the file’s rules belong to, derived from the file name.

Source

pub fn rules(&self) -> &[GuardRuleInfo]

Source

pub fn evaluate(&self, template: &Value) -> Result<Vec<GuardFinding>, String>

Evaluates every rule in the file against template, the authored template as CloudFormation JSON, and returns one finding per failed check. Rules that pass or are skipped by their when conditions produce nothing.

Trait Implementations§

Source§

impl Clone for GuardRuleFile

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for GuardRuleFile

Source§

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

Formats the value using the given formatter. Read more

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, 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> 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 = !

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

fn try_from(value: U) -> Result<T, !>

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.