Jaxon

v1.0.10

Jaxon v1.0.10 Jaxon.Path View Source

Utility module for parsing and encoding JSON path expressions.

Link to this section Summary

Types

t()

Functions

encode(path)

Encoding path expressions

encode!(path)
parse(bin)

Parse path expressions

parse!(bin)

Parse path expressions

Link to this section Types

Link to this type

t() View Source 
t() :: [String.t() | :all | :root | integer()]

Link to this section Functions

Link to this function

encode(path) View Source 
encode(t()) :: {:ok, String.t()} | {:error, String.t()}

Encoding path expressions:

iex> Jaxon.Path.encode([:root, "test", 0])
{:ok, "$.test[0]"}

How to handle encode errors:

iex> Jaxon.Path.encode([:root, :whoops, "test", 0])
{:error, %Jaxon.EncodeError{message: "`:whoops` is not a valid JSON path segment"}}
Link to this function

encode!(path) View Source 
encode!(t()) :: String.t() | no_return()

Link to this function

parse(bin) View Source 
parse(String.t()) :: {:ok, t()} | {:error, String.t()}

Parse path expressions:

iex> Jaxon.Path.parse("$[*].pets[0]")
{:ok, [:root, :all, "pets", 0]}

How to handle parse errors;

iex> Jaxon.Path.parse("$.test[x]")
{:error, %Jaxon.ParseError{message: "Expected an integer at `x]`"}}
iex> Jaxon.Path.parse("$.\"test[x]")
{:error, %Jaxon.ParseError{message: "Ending quote not found for string at `\"test[x]`"}}
Link to this function

parse!(bin) View Source 
parse!(String.t()) :: t() | no_return()

Parse path expressions:

iex> Jaxon.Path.parse!("$[*].pets[0]")
[:root, :all, "pets", 0]