Enum pact_consumer::prelude::JsonPattern

pub enum JsonPattern {
    Json(Value),
    Array(Vec<JsonPattern>),
    Object(Map<String, JsonPattern>),
    Pattern(Box<dyn Pattern<Matches = Value>>),
}

A pattern which can be used to either:

1. generate a sample JSON value using to_json, or
2. test whether a JSON value matches the pattern.

Many common Rust types may be converted into JSON patterns using into(), or the provided helper functions:

use pact_consumer::prelude::*;

let s: JsonPattern = "example".into();
let b: JsonPattern = true.into();
let v: JsonPattern = vec!["a", "b"].into();
let n = JsonPattern::null();

For more complicated values, see the json_pattern! macro.

Variants

Json(Value)

A regular JSON value, implemented by serde_json::Value. Contains no special matching rules.

Array(Vec<JsonPattern>)

An array of JSON patterns. May contain nested matching rules.

Object(Map<String, JsonPattern>)

An object containing JSON patterns. May contain nested matching rules.

Pattern(Box<dyn Pattern<Matches = Value>>)

A term which contains an arbitrary matchable. This is where rules like Like hook into our syntax.

Implementations

impl JsonPattern

pub fn null() -> JsonPattern

Construct a JSON null value.

pub fn pattern<P>(pattern: P) -> JsonPattern where
    P: Pattern<Matches = Value> + 'static, 

Construct a JSON pattern from a type implementing Pattern.

Trait Implementations

impl Debug for JsonPattern

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

Formats the value using the given formatter.

impl<'a, T: Clone + Into<JsonPattern>> From<&'a [T]> for JsonPattern

fn from(arr: &'a [T]) -> Self

Converts to this type from the input type.

impl<'a> From<&'a str> for JsonPattern

fn from(s: &'a str) -> Self

Converts to this type from the input type.

impl<'a> From<Cow<'a, str>> for JsonPattern

fn from(s: Cow<'a, str>) -> Self

Converts to this type from the input type.

impl From<DateTime<JsonPattern>> for JsonPattern

fn from(pattern: DateTime<JsonPattern>) -> Self

Converts to this type from the input type.

impl From<EachLike> for JsonPattern

fn from(pattern: EachLike) -> Self

Converts to this type from the input type.

impl From<HashMap<String, JsonPattern, RandomState>> for JsonPattern

fn from(m: Map<String, JsonPattern>) -> Self

Converts to this type from the input type.

impl From<Like<JsonPattern>> for JsonPattern

fn from(pattern: Like<JsonPattern>) -> Self

Converts to this type from the input type.

impl From<Map<String, Value>> for JsonPattern

fn from(n: Map<String, Value>) -> Self

Converts to this type from the input type.

impl From<String> for JsonPattern

fn from(n: String) -> Self

Converts to this type from the input type.

impl From<Term<JsonPattern>> for JsonPattern

fn from(pattern: Term<JsonPattern>) -> Self

Converts to this type from the input type.

impl From<Value> for JsonPattern

fn from(j: Value) -> Self

Converts to this type from the input type.

impl<T: Into<JsonPattern>> From<Vec<T, Global>> for JsonPattern

fn from(arr: Vec<T>) -> Self

Converts to this type from the input type.

impl From<bool> for JsonPattern

fn from(n: bool) -> Self

Converts to this type from the input type.

impl From<f32> for JsonPattern

fn from(n: f32) -> Self

Converts to this type from the input type.

impl From<f64> for JsonPattern

fn from(n: f64) -> Self

Converts to this type from the input type.

impl From<i16> for JsonPattern

fn from(n: i16) -> Self

Converts to this type from the input type.

impl From<i32> for JsonPattern

fn from(n: i32) -> Self

Converts to this type from the input type.

impl From<i64> for JsonPattern

fn from(n: i64) -> Self

Converts to this type from the input type.

impl From<i8> for JsonPattern

fn from(n: i8) -> Self

Converts to this type from the input type.

impl From<isize> for JsonPattern

fn from(n: isize) -> Self

Converts to this type from the input type.

impl From<u16> for JsonPattern

fn from(n: u16) -> Self

Converts to this type from the input type.

impl From<u32> for JsonPattern

fn from(n: u32) -> Self

Converts to this type from the input type.

impl From<u64> for JsonPattern

fn from(n: u64) -> Self

Converts to this type from the input type.

impl From<u8> for JsonPattern

fn from(n: u8) -> Self

Converts to this type from the input type.

impl From<usize> for JsonPattern

fn from(n: usize) -> Self

Converts to this type from the input type.

impl<T: Into<JsonPattern>> FromIterator<T> for JsonPattern

fn from_iter<I: IntoIterator<Item = T>>(iter: I) -> Self

Creates a value from an iterator.

impl Pattern for JsonPattern

type Matches = Value

What type of data can this pattern be matched against? What kind of example data does it generate?

fn to_example(&self) -> Value

Convert this Matchable into an example data value, stripping out any special match rules.

fn extract_matching_rules(
    &self,
    path: DocPath,
    rules_out: &mut MatchingRuleCategory
)

Extract the matching rules from this Matchable, and insert them into rules_out, using path as the base path.