httpoison_form_data v0.1.3 FormData

This module contains the recursive traversal algorithm used to build properly formatted names for both multipart and urlencoded requests.

Link to this section Summary

Functions

This function chooses the correct formatter and uses it in conjunction with the recursive name-formatting algorithm to produce the desired data structure

This function chooses the correct formatter and uses it in conjunction with the recursive name-formatting algorithm to produce the desired data structure

Link to this section Types

Link to this type input_type()
input_type() :: keyword() | map() | struct()

Link to this section Functions

Link to this function create(obj, formatter, output_opts \\ [])
create(obj :: input_type(), formatter :: module(), output_opts :: keyword(boolean())) ::
  {:ok, payload()} |
  {:error, String.t()}

This function chooses the correct formatter and uses it in conjunction with the recursive name-formatting algorithm to produce the desired data structure.

The built-in formatters are Multipart and URLEncoded, but a 3rd-party formatter that is a behaviour of FormData.Formatter can be passed in as well.

Link to this function create!(obj, formatter, output_opts \\ [])
create!(obj :: input_type(), formatter :: module(), output_opts :: keyword(boolean())) :: payload()

This function chooses the correct formatter and uses it in conjunction with the recursive name-formatting algorithm to produce the desired data structure.

The built-in formatters are Multipart and URLEncoded, but a 3rd-party formatter that is a behaviour of FormData.Formatter can be passed in as well.