JsonLogic Class

Namespace: Json.Logic

Inheritance: JsonLogic 🡒 object

Provides factory methods to create operations.

Methods

Add(Rule a, params Rule[] more)

Creates a + (“add”) rule.

Declaration

public static Rule Add(Rule a, params Rule[] more)

Parameter	Type	Description
a	Rule	The first rule.
more	params Rule[]	Subsequent rules.

Returns

A + rule.

Add(Rule a, ReadOnlySpan<Rule> more)

Declaration

public static Rule Add(Rule a, ReadOnlySpan<Rule> more)

Returns

All(Rule input, Rule rule)

Creates an all rule.

Declaration

public static Rule All(Rule input, Rule rule)

Parameter	Type	Description
input	Rule	The input rule.
rule	Rule	The predicate to test by.

Returns

An all rule.

And(Rule a, params Rule[] more)

Creates an and rule.

Declaration

public static Rule And(Rule a, params Rule[] more)

Parameter	Type	Description
a	Rule	The first rule.
more	params Rule[]	Subsequent rules.

Returns

An and rule.

And(Rule a, ReadOnlySpan<Rule> more)

Declaration

public static Rule And(Rule a, ReadOnlySpan<Rule> more)

Returns

Apply(JsonNode rule, JsonNode context)

Applies a rule encoded into a System.Text.Json.Nodes.JsonNode to some data.

Declaration

public static JsonNode Apply(JsonNode rule, JsonNode context)

Parameter	Type	Description
rule	JsonNode	The rule to apply.
context	JsonNode	The context data.

Returns

The result.

Apply(JsonNode rule, EvaluationContext context)

Applies a nested rule encoded into a System.Text.Json.Nodes.JsonNode to a context. This is to be called from within an Json.Logic.IRule handler.

Declaration

public static JsonNode Apply(JsonNode rule, EvaluationContext context)

Parameter	Type	Description
rule	JsonNode	The rule to apply.
context	EvaluationContext	The context data.

Returns

The result.

BetweenExclusive(Rule a, Rule b, Rule c)

Creates a three-argument < (“exclusive between”) rule.

Declaration

public static Rule BetweenExclusive(Rule a, Rule b, Rule c)

Parameter	Type	Description
a	Rule	The lower limit rule.
b	Rule	The rule.
c	Rule	The upper limit rule.

Returns

A < rule.

BetweenInclusive(Rule a, Rule b, Rule c)

Creates a three-argument <= (“inclusive between”) rule.

Declaration

public static Rule BetweenInclusive(Rule a, Rule b, Rule c)

Parameter	Type	Description
a	Rule	The lower limit rule.
b	Rule	The second rule.
c	Rule	The upper limit rule.

Returns

A <= rule.

BoolCast(Rule value)

Creates a !! (“boolean cast”) rule.

Declaration

public static Rule BoolCast(Rule value)

Parameter	Type	Description
value	Rule	The rule to negate.

Returns

A !! rule.

Cat(Rule a, params Rule[] more)

Creates a cat (“concatenation”) rule.

Declaration

public static Rule Cat(Rule a, params Rule[] more)

Parameter	Type	Description
a	Rule	The first rule.
more	params Rule[]	Subsequent rules.

Returns

A cat rule.

Cat(Rule a, ReadOnlySpan<Rule> more)

Declaration

public static Rule Cat(Rule a, ReadOnlySpan<Rule> more)

Returns

Divide(Rule a, Rule b)

Creates a / (“divide”) rule.

Declaration

public static Rule Divide(Rule a, Rule b)

Parameter	Type	Description
a	Rule	The first rule.
b	Rule

Returns

A / rule.

Filter(Rule input, Rule rule)

Creates a filter rule.

Declaration

public static Rule Filter(Rule input, Rule rule)

Parameter	Type	Description
input	Rule	The input rule.
rule	Rule	The predicate to test by.

Returns

A filter rule.

If(params Rule[] components)

Creates an if rule.

Declaration

public static Rule If(params Rule[] components)

Parameter	Type	Description
components	params Rule[]	The rule chain to process.

Returns

An if rule.

In(Rule test, Rule input)

Creates a none rule.

Declaration

public static Rule In(Rule test, Rule input)

Parameter	Type	Description
test	Rule	The predicate to test by.
input	Rule	The input rule.

Returns

A none rule.

LessThan(Rule a, Rule b)

Creates a < (“less than”) rule.

Declaration

public static Rule LessThan(Rule a, Rule b)

Parameter	Type	Description
a	Rule	The lower limit rule.
b	Rule	The upper limit rule.

Returns

A < rule.

LessThanOrEqual(Rule a, Rule b)

Creates a <= (“less than or equal”) rule.

Declaration

public static Rule LessThanOrEqual(Rule a, Rule b)

Parameter	Type	Description
a	Rule	The lower limit rule.
b	Rule	The upper limit rule.

Returns

A <= rule.

Literal(JsonNode value)

Creates a rule that stands in for a literal JSON value.

Declaration

public static Rule Literal(JsonNode value)

Parameter	Type	Description
value	JsonNode	The JSON value.

Returns

A literal rule.

Log(Rule log)

Functions as a no-op. Processes the rule, then logs and returns the output.

Declaration

public static Rule Log(Rule log)

Parameter	Type	Description
log	Rule	The rule to log.

Returns

The result of the rule.

LooseEquals(Rule a, Rule b)

Creates a == (“loose equal”) rule.

Declaration

public static Rule LooseEquals(Rule a, Rule b)

Parameter	Type	Description
a	Rule	The first rule.
b	Rule	The second rule.

Returns

A == rule.

LooseNotEquals(Rule a, Rule b)

Creates a != (“loose not equal”) rule.

Declaration

public static Rule LooseNotEquals(Rule a, Rule b)

Parameter	Type	Description
a	Rule	The first rule.
b	Rule	The second rule.

Returns

A != rule.

Map(Rule input, Rule rule)

Creates a map rule.

Declaration

public static Rule Map(Rule input, Rule rule)

Parameter	Type	Description
input	Rule	The input rule.
rule	Rule	The predicate to test by.

Returns

A map rule.

Max(Rule a, params Rule[] more)

Creates a max rule.

Declaration

public static Rule Max(Rule a, params Rule[] more)

Parameter	Type	Description
a	Rule	The first rule.
more	params Rule[]	Subsequent rules.

Returns

A max rule.

Max(Rule a, ReadOnlySpan<Rule> more)

Declaration

public static Rule Max(Rule a, ReadOnlySpan<Rule> more)

Returns

Merge(params Rule[] items)

Creates a merge rule.

Declaration

public static Rule Merge(params Rule[] items)

Parameter	Type	Description
items	params Rule[]	The items to merge.

Returns

A merge rule.

Min(Rule a, params Rule[] more)

Creates a min rule.

Declaration

public static Rule Min(Rule a, params Rule[] more)

Parameter	Type	Description
a	Rule	The first rule.
more	params Rule[]	Subsequent rules.

Returns

A min rule.

Min(Rule a, ReadOnlySpan<Rule> more)

Declaration

public static Rule Min(Rule a, ReadOnlySpan<Rule> more)

Returns

Missing(params Rule[] components)

Creates a missing rule.

Declaration

public static Rule Missing(params Rule[] components)

Parameter	Type	Description
components	params Rule[]	The missing components.

Returns

A missing rule.

MissingSome(Rule requiredCount, Rule components)

Creates a missing-some rule.

Declaration

public static Rule MissingSome(Rule requiredCount, Rule components)

Parameter	Type	Description
requiredCount	Rule	The required count.
components	Rule	The missing components.

Returns

A missing_some rule.

Modulus(Rule a, Rule b)

Creates a % (“modulus”) rule.

Declaration

public static Rule Modulus(Rule a, Rule b)

Parameter	Type	Description
a	Rule	The first rule.
b	Rule

Returns

A % rule.

MoreThan(Rule a, Rule b)

Creates a > (“more than”) rule.

Declaration

public static Rule MoreThan(Rule a, Rule b)

Parameter	Type	Description
a	Rule	The upper limit rule.
b	Rule	The lower limit rule.

Returns

A > rule.

MoreThanOrEqual(Rule a, Rule b)

Creates a >= (“more than or equal”) rule.

Declaration

public static Rule MoreThanOrEqual(Rule a, Rule b)

Parameter	Type	Description
a	Rule	The upper limit rule.
b	Rule	The lower limit rule.

Returns

A > rule.

Multiply(Rule a, params Rule[] more)

Creates a * (“multiply”) rule.

Declaration

public static Rule Multiply(Rule a, params Rule[] more)

Parameter	Type	Description
a	Rule	The first rule.
more	params Rule[]	Subsequent rules.

Returns

A * rule.

Multiply(Rule a, ReadOnlySpan<Rule> more)

Declaration

public static Rule Multiply(Rule a, ReadOnlySpan<Rule> more)

Returns

None(Rule input, Rule rule)

Creates a none rule.

Declaration

public static Rule None(Rule input, Rule rule)

Parameter	Type	Description
input	Rule	The input rule.
rule	Rule	The predicate to test by.

Returns

A none rule.

Not(Rule value)

Creates a ! (“not”) rule.

Declaration

public static Rule Not(Rule value)

Parameter	Type	Description
value	Rule	The rule to negate.

Returns

A ! rule.

Or(Rule a, params Rule[] more)

Creates an or rule.

Declaration

public static Rule Or(Rule a, params Rule[] more)

Parameter	Type	Description
a	Rule	The first rule.
more	params Rule[]	Subsequent rules.

Returns

An or rule.

Or(Rule a, ReadOnlySpan<Rule> more)

Declaration

public static Rule Or(Rule a, ReadOnlySpan<Rule> more)

Returns

Reduce(Rule input, Rule rule, Rule initial)

Creates a reduce rule.

Declaration

public static Rule Reduce(Rule input, Rule rule, Rule initial)

Parameter	Type	Description
input	Rule	The input rule.
rule	Rule	The predicate to test by.
initial	Rule	The initial rule.

Returns

A reduce rule.

Some(Rule input, Rule rule)

Creates a some (“any”) rule.

Declaration

public static Rule Some(Rule input, Rule rule)

Parameter	Type	Description
input	Rule	The input rule.
rule	Rule	The predicate to test by.

Returns

A some rule.

StrictEquals(Rule a, Rule b)

Creates a === (“strict equal”) rule.

Declaration

public static Rule StrictEquals(Rule a, Rule b)

Parameter	Type	Description
a	Rule	The first rule.
b	Rule	The second rule.

Returns

A === rule.

StrictNotEquals(Rule a, Rule b)

Creates a !== (“strict not equal”) rule.

Declaration

public static Rule StrictNotEquals(Rule a, Rule b)

Parameter	Type	Description
a	Rule	The first rule.
b	Rule	The second rule.

Returns

A !== rule.

Substr(Rule input, Rule start)

Creates a substr (“concatenation”) rule.

Declaration

public static Rule Substr(Rule input, Rule start)

Parameter	Type	Description
input	Rule	The input rule.
start	Rule	The start rule.

Returns

A substr rule.

Substr(Rule input, Rule start, Rule count)

Creates a substr (“concatenation”) rule.

Declaration

public static Rule Substr(Rule input, Rule start, Rule count)

Parameter	Type	Description
input	Rule	The input rule.
start	Rule	The start rule.
count	Rule	The count rule.

Returns

A substr rule.

Subtract(Rule a, params Rule[] more)

Creates a - (“subtract”) rule.

Declaration

public static Rule Subtract(Rule a, params Rule[] more)

Parameter	Type	Description
a	Rule	The first rule.
more	params Rule[]	Subsequent rules.

Returns

A - rule.

Subtract(Rule a, ReadOnlySpan<Rule> more)

Declaration

public static Rule Subtract(Rule a, ReadOnlySpan<Rule> more)

Returns

Variable(Rule input)

Creates a var rule that accesses data.

Declaration

public static Rule Variable(Rule input)

Parameter	Type	Description
input	Rule	A rule that produces the dot-delimited path.

Returns

A variable rule.

Variable(string path)

Creates a var rule that accesses data.

Declaration

public static Rule Variable(string path)

Parameter	Type	Description
path	string	The dot-delimited path.

Returns

A variable rule.

Variable(Rule input, Rule defaultValue)

Creates a var rule that accesses data.

Declaration

public static Rule Variable(Rule input, Rule defaultValue)

Parameter	Type	Description
input	Rule	A rule that produces the dot-delimited path.
defaultValue	Rule	A default value to use if the path is not found.

Returns

A variable rule.

Variable(string path, Rule defaultValue)

Creates a var rule that accesses data.

Declaration

public static Rule Variable(string path, Rule defaultValue)

Parameter	Type	Description
path	string	The dot-delimited path.
defaultValue	Rule	A default value to use if the path is not found.

Returns

A variable rule.