bytestring

Fast, compact, strict and lazy byte strings with a list interface

https://github.com/haskell/bytestring

Version on this page:0.10.4.0
LTS Haskell 22.14:0.11.5.3
Stackage Nightly 2024-03-28:0.12.1.0
Latest on Hackage:0.12.1.0@rev:1

See all snapshots bytestring appears in

BSD-3-Clause licensed by Don Stewart, Duncan Coutts
Maintained by Don Stewart, Duncan Coutts
This version can be pinned in stack with:bytestring-0.10.4.0@sha256:b2155e1b04a2a755c738213bbc06b9d832d754c1f731f4355875d12ff3a28685,7909

Module documentation for 0.10.4.0

An efficient compact, immutable byte string type (both strict and lazy) suitable for binary or 8-bit character data.

The ByteString type represents sequences of bytes or 8-bit characters. It is suitable for high performance use, both in terms of large data quantities, or high speed requirements. The ByteString functions follow the same style as Haskell's ordinary lists, so it is easy to convert code from using String to ByteString.

Two ByteString variants are provided:

  • Strict ByteStrings keep the string as a single large array. This makes them convenient for passing data between C and Haskell.

  • Lazy ByteStrings use a lazy list of strict chunks which makes it suitable for I/O streaming tasks.

The Char8 modules provide a character-based view of the same underlying ByteString types. This makes it convenient to handle mixed binary and 8-bit character content (which is common in many file formats and network protocols).

The Builder module provides an efficient way to build up ByteStrings in an ad-hoc way by repeated concatenation. This is ideal for fast serialisation or pretty printing.

There is also a ShortByteString type which has a lower memory overhead and can can be converted to or from a ByteString, but supports very few other operations. It is suitable for keeping many short strings in memory.

ByteStrings are not designed for Unicode. For Unicode strings you should use the Text type from the text package.

These modules are intended to be imported qualified, to avoid name clashes with Prelude functions, e.g.

import qualified Data.ByteString as BS