stream_runner v1.0.1 → Overview → StreamRunner

StreamRunner

The StreamRunner provides a convenient way to run a Stream as process in a supervisor tree.

To run a Stream as a process simply pass the stream to StreamRunner.start_link/1:

stream = Stream.interval(1_000) |> Stream.each(&IO.inspect/1)
{:ok, pid} = StreamRunner.start_link(stream)

Source

Summary↑

start(stream, opts \\ [])	Start a `StreamRunner`
start_link(stream, opts \\ [])	Start a `StreamRunner` as part of the supervision tree

debug_option :: :trace | :log | :statistics | {:log_to_file, Path.t}

Debug option values.

name :: atom | {:global, term} | {:via, module, term}

The name of the StreamRunner.

option :: {:debug, [debug_option]} | {:name, name} | {:timeout, timeout} | {:spawn_opt, Process.spawn_opt}

on_start :: {:ok, pid} | :ignore | {:error, {:already_started, pid} | term}

start(stream, opts \\ [])

(function) # ↑

The StreamRunner is not linked to the calling process.

Source

start_link(stream, opts \\ [])

(function) # ↑

Specs:

Start a StreamRunner as part of the supervision tree.

Source