Packages

exd

0.1.2
0.2.1 0.2.0 0.1.36 0.1.35 0.1.34 0.1.33 0.1.32 0.1.31 0.1.30 0.1.29 0.1.28 0.1.27 0.1.26 0.1.25 0.1.24 0.1.23 0.1.22 0.1.21 0.1.20 0.1.19 0.1.17 0.1.16 0.1.15 0.1.14 0.1.13 0.1.12 0.1.11 0.1.10 0.1.9 0.1.8 0.1.7 0.1.6 0.1.5 0.1.4 0.1.3 0.1.2 0.1.1 0.1.0

A few sentences (a paragraph) describing the project.

HexDocs

Current section

Files

Jump to
Readme
38 Versions
4 Dependencies
Dependants
Files
Activity
exd lib exd source adapter.ex
Raw

lib/exd/source/adapter.ex 

defmodule Exd.Source.Adapter do

  @moduledoc """

  Adapter for source implementations

  """



  @typedoc "State of source"

  @type state :: map



  @typedoc "State of source"

  @type demand :: integer



  @typedoc "State of source"

  @type config :: keyword



  @typedoc "State of source"

  @type context :: [map]



  @typedoc "State of source"

  @type documents :: [map]



  @doc """

  Initializes the state of the source

  """

  @callback init(config) :: {:ok, state}



  @doc """

  Initializes the state of the source

  """

  @callback handle_from(demand, state) :: {:ok, documents, state} | :done



  @doc false

  defmacro __using__(_opts) do

    quote do

      @behaviour Exd.Source.Adapter

    end

  end



end