Skip to content

Commit

Permalink
Merge pull request #391 from caenrique/replace-segment-with-chunk-in-…
Browse files Browse the repository at this point in the history
…readme

docs: replace Segment with Chunk
  • Loading branch information
armanbilge authored Nov 10, 2022
2 parents 4294346 + b74e8f1 commit 15e24ea
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,15 +30,15 @@ is:
```

The appropriate pipe for the job also depends on your input stream value type (i.e. `String`, `Byte`
or `Segment[Byte]`).
or `Chunk[Byte]`).

The following table sums up every pipe available as a function of the input stream value type as
well as the JSON structure:

| |String |Byte |Segment[Byte] |
| |String |Byte |Chunk[Byte] |
|----------------|--------------------|------------------|-------------------|
|__Value stream__|`stringStreamParser`|`byteStreamParser`|`byteStreamParserS`|
|__Array__ |`stringArrayParser` |`byteArrayParser` |`byteArrayParserS` |
|__Value stream__|`stringStreamParser`|`byteStreamParser`|`byteStreamParserC`|
|__Array__ |`stringArrayParser` |`byteArrayParser` |`byteArrayParserC` |

As an example, let's say we have a stream of strings representing a JSON array, we'll
pick the `stringArrayParser` pipe which converts a stream of `String` to a stream of `Json`, Circe's
Expand Down

0 comments on commit 15e24ea

Please sign in to comment.