Struct JsonMatchPattern

#[non_exhaustive]
pub struct JsonMatchPattern {
    pub all: Option<All>,
    pub included_paths: Option<Vec<String>>,
}

The patterns to look for in the JSON body. WAF inspects the results of these pattern matches against the rule inspection criteria. This is used with the FieldToMatch option JsonBody.

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.

all: Option<All>

Match all of the elements. See also MatchScope in JsonBody.

You must specify either this setting or the IncludedPaths setting, but not both.

included_paths: Option<Vec<String>>

Match only the specified include paths. See also MatchScope in JsonBody.

Provide the include paths using JSON Pointer syntax. For example, "IncludedPaths": \["/dogs/0/name", "/dogs/1/name"\]. For information about this syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer.

You must specify either this setting or the All setting, but not both.

Don't use this option to include all paths. Instead, use the All setting.

Implementations

impl JsonMatchPattern

pub fn all(&self) -> Option<&All>

Match all of the elements. See also MatchScope in JsonBody.

You must specify either this setting or the IncludedPaths setting, but not both.

pub fn included_paths(&self) -> &[String]

Match only the specified include paths. See also MatchScope in JsonBody.

Provide the include paths using JSON Pointer syntax. For example, "IncludedPaths": \["/dogs/0/name", "/dogs/1/name"\]. For information about this syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer.

You must specify either this setting or the All setting, but not both.

Don't use this option to include all paths. Instead, use the All setting.

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

impl JsonMatchPattern

pub fn builder() -> JsonMatchPatternBuilder

Creates a new builder-style object to manufacture JsonMatchPattern.

Trait Implementations

impl Clone for JsonMatchPattern

fn clone(&self) -> JsonMatchPattern

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for JsonMatchPattern

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

Formats the value using the given formatter.

impl PartialEq for JsonMatchPattern

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