Plug.Conn.Query (Plug v1.11.0) View Source

Conveniences for decoding and encoding url encoded queries.

Plug allows a developer to build query strings that map to Elixir structures in order to make manipulation of such structures easier on the server side. Here are some examples:

iex> decode("foo=bar")["foo"]

If a value is given more than once, the last value takes precedence:

iex> decode("foo=bar&foo=baz")["foo"]

Nested structures can be created via [key]:

iex> decode("foo[bar]=baz")["foo"]["bar"]

Lists are created with []:

iex> decode("foo[]=bar&foo[]=baz")["foo"]
["bar", "baz"]

Maps can be encoded:

iex> encode(%{foo: "bar", baz: "bat"})

Encoding keyword lists preserves the order of the fields:

iex> encode([foo: "bar", baz: "bat"])

When encoding keyword lists with duplicate keys, the key that comes first takes precedence:

iex> encode([foo: "bar", foo: "bat"])

Encoding named lists:

iex> encode(%{foo: ["bar", "baz"]})

Encoding nested structures:

iex> encode(%{foo: %{bar: "baz"}})

Link to this section Summary


Decodes the given tuple and stores it in the accumulator.

Encodes the given map or list of tuples.

Link to this section Functions

Link to this function

decode(query, initial \\ %{}, invalid_exception \\ Plug.Conn.InvalidQueryError, validate_utf8 \\ true)

View Source

Decodes the given binary.

The binary is assumed to be encoded in "x-www-form-urlencoded" format. The format is decoded and then validated for proper UTF-8 encoding.

Decodes the given tuple and stores it in the accumulator.

It parses the key and stores the value into the current accumulator. The keys and values are not assumed to be encoded in "x-www-form-urlencoded".

Parameter lists are added to the accumulator in reverse order, so be sure to pass the parameters in reverse order.

Link to this function

encode(kv, encoder \\ &to_string/1)

View Source

Encodes the given map or list of tuples.