Packmatic.Encoder.stream_next

You're seeing just the function stream_next, go back to Packmatic.Encoder module for more information.
Link to this function

stream_next(status, state)

View Source

Specs

stream_next(:encoding, encoding_state()) ::
  {:ok, iodata(), :encoding, encoding_state()}
  | {:ok, iodata(), :journaling, journaling_state()}
  | {:error, term()}
stream_next(:journaling, journaling_state()) ::
  {:ok, iodata(), :journaling, journaling_state()} | {:ok, iodata(), :done, nil}
stream_next(:done, nil) :: {:ok, :halt, :done, nil}

Iterates the Stream.

When the Stream is in :encoding status, this function may continue encoding of the current item, or advance to the next item, or advance to the :journaling status when there are no further items to encode.

When the Stream is in :journaling status, this function may continue journaling the next item, or advance to the :done status.

When the Stream is in :done status, it can not be iterated further.