Dequel.Parser.Predicates
(Dequel v0.9.2)
View Source
Parses predicates (operators) in field expressions.
Syntax
Predicates appear after the colon in field expressions:
title:foobar # equality (implicit)
title:*foobar # contains (shorthand)
title:contains(foobar) # contains (explicit)Available Predicates
| Predicate | Shorthand | Example |
|---|---|---|
== | : | title:value |
contains | * | title:*value |
starts_with | ^ | title:^value |
ends_with | $ | title:$value |
one_of | [...] | title:[a, b, c] |
Multi-Value Expansion
Comma-separated values in parentheses expand to OR conditions:
name:contains(foo, bar)
# expands to: name:contains(foo) OR name:contains(bar)Think of it like the distributive property: p(a, b) = p(a) OR p(b).
Predicate Options
Options follow the value, separated by whitespace:
name:contains(frodo i)
# ^ case-insensitive flagThe parser accepts any options; validation is handled by the linter.
Summary
Functions
@spec between_call(binary(), keyword()) :: {:ok, [term()], rest, context, line, byte_offset} | {:error, reason, rest, context, line, byte_offset} when line: {pos_integer(), byte_offset}, byte_offset: non_neg_integer(), rest: binary(), reason: String.t(), context: map()
Parses the given binary as between_call.
Returns {:ok, [token], rest, context, position, byte_offset} or
{:error, reason, rest, context, line, byte_offset} where position
describes the location of the between_call (start position) as {line, offset_to_start_of_line}.
To column where the error occurred can be inferred from byte_offset - offset_to_start_of_line.
Options
:byte_offset- the byte offset for the whole binary, defaults to 0:line- the line and the byte offset into that line, defaults to{1, byte_offset}:context- the initial context value. It will be converted to a map
@spec function_call(binary(), keyword()) :: {:ok, [term()], rest, context, line, byte_offset} | {:error, reason, rest, context, line, byte_offset} when line: {pos_integer(), byte_offset}, byte_offset: non_neg_integer(), rest: binary(), reason: String.t(), context: map()
Parses the given binary as function_call.
Returns {:ok, [token], rest, context, position, byte_offset} or
{:error, reason, rest, context, line, byte_offset} where position
describes the location of the function_call (start position) as {line, offset_to_start_of_line}.
To column where the error occurred can be inferred from byte_offset - offset_to_start_of_line.
Options
:byte_offset- the byte offset for the whole binary, defaults to 0:line- the line and the byte offset into that line, defaults to{1, byte_offset}:context- the initial context value. It will be converted to a map