Data.Conduit.Binary

Functions for interacting with bytes.

Documentation

sourceFile :: ResourceIO m => FilePath -> Source m ByteString

Stream the contents of a file as binary data.

Since 0.2.0

sourceHandle :: ResourceIO m => Handle -> Source m ByteString

Stream the contents of a Handle as binary data. Note that this function will not automatically close the Handle when processing completes, since it did not acquire the Handle in the first place.

Since 0.2.0

sourceIOHandle :: ResourceIO m => IO Handle -> Source m ByteString

An alternative to sourceHandle. Instead of taking a pre-opened Handle, it takes an action that opens a Handle (in read mode), so that it can open it only when needed and close it as soon as possible.

Since 0.2.0

sourceFileRange

Arguments

:: ResourceIO m

=> FilePath

-> Maybe Integer

Offset

-> Maybe Integer

Maximum count

-> Source m ByteString

Stream the contents of a file as binary data, starting from a certain offset and only consuming up to a certain number of bytes.

Since 0.2.0

sinkFile :: ResourceIO m => FilePath -> Sink ByteString m ()

Stream all incoming data to the given file.

Since 0.2.0

sinkHandle :: ResourceIO m => Handle -> Sink ByteString m ()

Stream all incoming data to the given Handle. Note that this function will not automatically close the Handle when processing completes.

Since 0.2.0

sinkIOHandle :: ResourceIO m => IO Handle -> Sink ByteString m ()

An alternative to sinkHandle. Instead of taking a pre-opened Handle, it takes an action that opens a Handle (in write mode), so that it can open it only when needed and close it as soon as possible.

Since 0.2.0

conduitFile :: ResourceIO m => FilePath -> Conduit ByteString m ByteString

Stream the contents of the input to a file, and also send it along the pipeline. Similar in concept to the Unix command tee.

Since 0.2.0

isolate :: Resource m => Int -> Conduit ByteString m ByteString

Ensure that only up to the given number of bytes are consume by the inner sink. Note that this does not ensure that all of those bytes are in fact consumed.

Since 0.2.0

openFile :: ResourceIO m => FilePath -> IOMode -> ResourceT m Handle

Open a file Handle safely by automatically registering a release action.

While you are not required to call hClose on the resulting handle, you should do so as early as possible to free scarce resources.

Since 0.2.0

head :: Resource m => Sink ByteString m (Maybe Word8)

Return the next byte from the stream, if available.

Since 0.2.0

takeWhile :: Resource m => (Word8 -> Bool) -> Conduit ByteString m ByteString

Return all bytes while the predicate returns True.

Since 0.2.0

dropWhile :: Resource m => (Word8 -> Bool) -> Sink ByteString m ()

Ignore all bytes while the predicate returns True.

Since 0.2.0

take :: Resource m => Int -> Sink ByteString m ByteString

Take the given number of bytes, if available.

Since 0.2.0

lines :: Resource m => Conduit ByteString m ByteString

Split the input bytes into lines. In other words, split on the LF byte (10), and strip it from the output.

Since 0.2.0