Packages

kadabra

0.4.2
0.6.3 0.6.2 0.6.1 0.6.0 0.5.0 0.4.5 0.4.4 0.4.3 0.4.2 0.4.1 0.4.0 0.3.8 0.3.7 0.3.6 0.3.5 0.3.4 0.3.3 0.3.2 0.3.1 0.3.0 0.2.2 0.2.1 0.2.0 0.1.6 0.1.5 0.1.4 0.1.3 0.1.2 0.1.1 0.1.0

HTTP2 client for Elixir

HexDocs

Current section

Files

Jump to
Readme
30 Versions
2 Dependencies
Dependants
Files
Activity
kadabra lib encodable.ex
Raw

lib/encodable.ex 

defprotocol Kadabra.Encodable do

  @moduledoc false



  @dialyzer {:nowarn_function, __protocol__: 1}

  @fallback_to_any true



  @doc ~S"""

  Encodes to binary.



  ## Examples



      iex> Kadabra.Frame.Ping.new |> to_bin()

      <<0, 0, 8, 6, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0>>



      iex> %Kadabra.Connection.Settings{enable_push: false} |> to_bin()

      <<0, 5, 0, 0, 64, 0, 0, 4, 0, 0, 255, 255, 0, 1, 0, 0, 16, 0, 0, 2,

      0, 0, 0, 0>>



      iex> %Kadabra.Frame.Continuation{end_headers: true,

      ...> stream_id: 1, header_block_fragment: <<255, 255, 255>>} |> to_bin()

      <<0, 0, 3, 9, 4, 0, 0, 0, 1, 255, 255, 255>>



      iex> Kadabra.Encodable.to_bin(:any_non_frame_term)

      :error

  """

  @spec to_bin(any) :: binary | :error

  def to_bin(frame)

end



defimpl Kadabra.Encodable, for: Any do

  def to_bin(_), do: :error

end