Conduit v0.7.0 Conduit.Plug.Encode

Encodes the message body based on the content encoding.

It uses in order of preference:

  1. The content encoding specified for the plug.
  2. The content encoding specified on the message.
  3. The default content encoding identity.

This plug should be used in an outgoing pipeline. Generally after a Conduit.Plug.Format plug.

Examples

plug Conduit.Plug.Encode
plug Conduit.Plug.Encode, content_encoding: "gzip"

iex> import Conduit.Message
iex> message =
iex>   %Conduit.Message{}
iex>   |> put_body("{}")
iex>   |> Conduit.Plug.Encode.run
iex> message.body
"{}"
iex> message.content_encoding
"identity"

Summary

Functions

Encodes the message body based on the content encoding

Callback implementation for Conduit.Plug.init/1

Callback implementation for Conduit.Plug.run/2

Functions

call(message, next, opts)

Encodes the message body based on the content encoding.

init(opts)

Callback implementation for Conduit.Plug.init/1.

run(message, opts \\ [])

Callback implementation for Conduit.Plug.run/2.