View Source Warpath.Element.Path (Warpath v0.6.3)

This module contains functions to accumulate and transform item path tokens.

The path are built during a expression evaluation by Warpath.query/3.

Link to this section Summary

acc()

token()

Accumulate a path token into a path acc.

bracketify(paths)

Transform path tokens into a jsonpath bracket-notation representation.

dotify(paths)

Transform path tokens into a jsonpath dot-notation representation.

@type acc() :: [token(), ...] | []

@type token() ::
  {:root, String.t()}
  | {:property, String.t() | atom()}
  | {:index_access, integer()}

@spec accumulate(token(), acc()) :: acc()

Accumulate a path token into a path acc.

iex> acc = [{:root, "$"}]
...> Warpath.Element.Path.accumulate({:property, "name"}, acc)
[{:property, "name"}, {:root, "$"}]

@spec bracketify(acc()) :: binary()

Transform path tokens into a jsonpath bracket-notation representation.

iex> acc = [{:property, "name"}, {:root, "$"}]
...> Warpath.Element.Path.bracketify(acc)
"$['name']"

@spec dotify(acc()) :: binary()

Transform path tokens into a jsonpath dot-notation representation.

iex> acc = [{:property, "name"}, {:root, "$"}]
...> Warpath.Element.Path.dotify(acc)
"$.name"