Polysemy.Process.ProcessOutput

The utility effect ProcessOutput takes care of decoding process output, getting called by the Process interpreters whenever a chunk was read, while accumulating chunks until they were decoded successfully.

Documentation

data ProcessOutput (p :: OutputPipe) a :: Effect where

This effect is used by the effect Process to accumulate and decode chunks of ByteStrings, for example using a parser. The interpreter may be stateful or stateless, since the constructor Chunk is expected to be called with both the accumulated unprocessed output as well as the new chunk.

Constructors

Chunk

Add a chunk of output to the accumulator, returning any number of successfully parsed values and the leftover output.

Fields

• :: ByteString

  The accumulation of the previous leftovers.

• -> ByteString

  The new chunk read from the process.

• -> ProcessOutput p a m ([a], ByteString)

Instances

type DefiningModule ProcessOutput

Defined in Polysemy.Process.Effect.ProcessOutput

type DefiningModule ProcessOutput = "Polysemy.Process.Effect.ProcessOutput"

interpretProcessOutputId :: forall p r. InterpreterFor (ProcessOutput p ByteString) r

Interpret ProcessOutput by immediately emitting raw ByteStrings without accumulation.

interpretProcessOutputLines :: forall p r. InterpreterFor (ProcessOutput p ByteString) r

Interpret ProcessOutput by emitting individual ByteString lines of output.

interpretProcessOutputText :: forall p r. InterpreterFor (ProcessOutput p Text) r

Interpret ProcessOutput by immediately emitting Text without accumulation.

interpretProcessOutputTextLines :: forall p r. InterpreterFor (ProcessOutput p Text) r

Interpret ProcessOutput by emitting individual Text lines of output.