View Source Tesla.Multipart (tesla v1.11.0)

Multipart functionality.

Examples

mp =
  Multipart.new()
  |> Multipart.add_content_type_param("charset=utf-8")
  |> Multipart.add_field("field1", "foo")
  |> Multipart.add_field("field2", "bar",
    headers: [{"content-id", "1"}, {"content-type", "text/plain"}]
  )
  |> Multipart.add_file("test/tesla/multipart_test_file.sh")
  |> Multipart.add_file("test/tesla/multipart_test_file.sh", name: "foobar")
  |> Multipart.add_file_content("sample file content", "sample.txt")

response = client.post(url, mp)

Summary

Types

part_stream()

part_value()

t()

Functions

add_content_type_param(mp, param)

Add a parameter to the multipart content-type.

add_field(mp, name, value, opts \\ [])

Add a field part.

add_file(mp, path, opts \\ [])

Add a file part. The file will be streamed.

add_file_content(mp, data, filename, opts \\ [])

Add a file part with value.

new()

Create a new Multipart struct to be used for a request body.

Types

part_stream()

@type part_stream() :: Enum.t()

part_value()

@type part_value() :: iodata() | part_stream()

t()

@type t() :: %Tesla.Multipart{
  boundary: String.t(),
  content_type_params: [String.t()],
  parts: [Tesla.Multipart.Part.t()]
}

Functions

add_content_type_param(mp, param)

@spec add_content_type_param(t(), String.t()) :: t()

Add a parameter to the multipart content-type.

add_field(mp, name, value, opts \\ [])

@spec add_field(t(), String.t(), part_value(), Keyword.t()) :: t() | no_return()

Add a field part.

add_file(mp, path, opts \\ [])

@spec add_file(t(), String.t(), Keyword.t()) :: t()

Add a file part. The file will be streamed.

Options

:name - name of form param
:filename - filename (defaults to path basename)
:headers - additional headers
:detect_content_type - auto-detect file content-type (defaults to false)

add_file_content(mp, data, filename, opts \\ [])

@spec add_file_content(t(), part_value(), String.t(), Keyword.t()) :: t()

Add a file part with value.

Same of add_file/3 but the file content is read from data input argument.

Options

:name - name of form param
:headers - additional headers

new()

@spec new() :: t()

Create a new Multipart struct to be used for a request body.