Cizen.Effect behaviour (Cizen v0.18.1) View Source

The effect behaviour.

Example

defmodule Repeat do
  use Cizen.Effect
  use Cizen.Effects, only: [Chain]
  defstruct [:count, :effect, :pid]
  @impl true
  def expand(id, %__MODULE__{count: count, effect: effect, pid: pid}) do
    effects =
      [effect]
      |> Stream.cycle()
      |> Enum.take(count)

    %Chain{
      effects: effects
    }
  end
end

Link to this section Summary

Types

alias_of()

consume()

handler()

resolve()

t()

Functions

handle_event(handler, event, effect, state)

init(handler, effect)

Callbacks

expand(handler, t)

handle_event(handler, arg2, t, state)

init(handler, t)

Link to this section Types

alias_of()

Specs

alias_of() :: {:alias_of, t()}

consume()

Specs

consume() :: {:consume, term()}

handler()

Specs

handler() :: Cizen.SagaID.t()

resolve()

Specs

resolve() :: {:resolve, term()}

t()

Specs

t() :: struct()

Link to this section Functions

handle_event(handler, event, effect, state)

Specs

handle_event(handler(), Cizen.Event.t(), t(), state :: term()) ::
  resolve() | consume() | term()

init(handler, effect)

Specs

init(handler(), t()) :: resolve() | {t(), term()}

Link to this section Callbacks

expand(handler, t)

Specs

expand(handler(), t()) :: t()

handle_event(handler, arg2, t, state)

Specs

handle_event(handler(), Cizen.Event.t(), t(), state :: term()) ::
  resolve() | consume() | term()

init(handler, t)

Specs

init(handler(), t()) :: resolve() | alias_of() | term()