FS.Bytes

(source)

Utilities for working with streams of byte arrays.

Reexports

import public Data.ByteString

Definitions

emitBS : ByteString -> Pull f ByteString es ()

Totality: total
Visibility: export

consBS : ByteString -> Pull f ByteString es r -> Pull f ByteString es r

Totality: total
Visibility: export

unlines : Pull f (List ByteString) es r -> Pull f ByteString es r

  Appends a newline character (`0x0a`) to every bytestring
  emitted by the stream.
  
  A chunk (list) of bytestring is thus concatenated to a single
  byte vector. See also `lines`.

Totality: total
Visibility: export

lines : Pull f ByteString es r -> Pull f (List ByteString) es r

  Breaks the bytes emitted by a byte stream along unix newline
  characters (`0x0a`).
  
  For reasons of efficiency, this emits the produce lines as
  a list of bytestrings.

Totality: total
Visibility: export

breakNL : Pull f ByteString es r -> Pull f ByteString es r

  Breaks the chunks emitted by a byte stream along the last
  unix new-line character (`0x0a`) of each chunk.

Totality: total
Visibility: export

breakAtSubstring : (r -> Pull f ByteString es r) -> ByteString -> Pull f ByteString es r -> Pull f ByteString es (Pull f ByteString es r)

  Breaks the output generated by a pull at the first occurence
  of the given byte sequence.
  
  The substring is removed from the emitted byte sequence,
  and the remainder of the pull returned (if any).

Totality: total
Visibility: export

forceBreakAtSubstring : Has e es => Lazy e -> ByteString -> Pull f ByteString es r -> Pull f ByteString es (Pull f ByteString es r)

  Like `breakAtSubstring` but fails with the given error if
  the substring is not encountered.

Totality: total
Visibility: export

chunks : Stream f es ByteString -> Stream f es ByteString

  Converts the byte vectors emitted by a stream to byte vectors
  that always end at whole code points.
  
  Note: Typically, this needs to be prefixed with the outer namespace:
        `UTF8.chunks`

Totality: total
Visibility: export

decode : Stream f es ByteString -> Stream f es String

  Cuts the byte vectors emitted by a stream at the end of whole
  UTF-8 code points and converts them to `String`s.
  
  Note: Typically, this needs to be prefixed with the outer namespace:
        `UTF8.decode`

Totality: total
Visibility: export

encode : Stream f es String -> Stream f es ByteString

  Converts a stream of strings to UTF-8-encoded byte strings.
  
  Note: Typically, this needs to be prefixed with the outer namespace:
        `UTF8.encode`

Totality: total
Visibility: export