Core.Text.Bytes

Binary (as opposed to textual) data is encountered in weird corners of the Haskell ecosystem. We tend to forget (for example) that the content recieved from a web server is not text until we convert it from UTF-8 (if that's what it is); and of course that glosses over the fact that something of content-type image/jpeg is not text in any way, shape, or form.

Bytes also show up when working with crypto algorithms, taking hashes, and when doing serialization to external binary formats. Although we frequently display these in terminals (and in URLs!) as text, but we take for granted that we have actually deserialized the data or rendered the it in hexidecimal or base64 or...

This module presents a simple wrapper around various representations of binary data to make it easier to interoperate with libraries supplying or consuming bytes.

Documentation

data Bytes

A block of data in binary form.

Instances

Generic Bytes

Defined in Core.Text.Bytes

Associated Types

type Rep Bytes :: Type -> Type

Methods

from :: Bytes -> Rep Bytes x

to :: Rep Bytes x -> Bytes

Show Bytes

Defined in Core.Text.Bytes

Methods

showsPrec :: Int -> Bytes -> ShowS

show :: Bytes -> String

showList :: [Bytes] -> ShowS

Binary Bytes

Defined in Core.Text.Bytes

Methods

fromBytes :: Bytes -> Bytes

intoBytes :: Bytes -> Bytes

Textual Bytes

Defined in Core.Text.Rope

Methods

fromRope :: Rope -> Bytes

intoRope :: Bytes -> Rope

appendRope :: Bytes -> Rope -> Rope

Render Bytes

Defined in Core.Text.Utilities

Associated Types

type Token Bytes

Methods

colourize :: Token Bytes -> AnsiColour

highlight :: Bytes -> Doc (Token Bytes)

Eq Bytes

Defined in Core.Text.Bytes

Methods

(==) :: Bytes -> Bytes -> Bool

(/=) :: Bytes -> Bytes -> Bool

Ord Bytes

Defined in Core.Text.Bytes

Methods

compare :: Bytes -> Bytes -> Ordering

(<) :: Bytes -> Bytes -> Bool

(<=) :: Bytes -> Bytes -> Bool

(>) :: Bytes -> Bytes -> Bool

(>=) :: Bytes -> Bytes -> Bool

max :: Bytes -> Bytes -> Bytes

min :: Bytes -> Bytes -> Bytes

Hashable Bytes

Defined in Core.Text.Bytes

Methods

hashWithSalt :: Int -> Bytes -> Int

hash :: Bytes -> Int

type Rep Bytes

Defined in Core.Text.Bytes

type Rep Bytes = D1 ('MetaData "Bytes" "Core.Text.Bytes" "core-text-0.3.8.1-KEEtRRMfJlNIUNmGCyYR34" 'True) (C1 ('MetaCons "StrictBytes" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString)))

type Token Bytes

Defined in Core.Text.Utilities

type Token Bytes = ()

emptyBytes :: Bytes

A zero-length Bytes.

packBytes :: String -> Bytes

For the annoyingly common case of needing to take an ASCII string literal in your code and use it as a bunch of Bytes.

Done via Data.ByteString.Char8 so all Chars will be truncated to 8 bits (i.e. Latin-1 characters less than 255). You should probably consider this to be unsafe. Also note that we deliberately do not have a [Char] instance of Binary; if you need to come back to a textual representation use intoRope.

class Binary α where

Conversion to and from various types containing binary data into our convenience Bytes type.

As often as not these conversions are expensive; these methods are here just to wrap calling the relevant functions in a uniform interface.

Methods

fromBytes :: Bytes -> α

intoBytes :: α -> Bytes

Instances

Binary Builder

Defined in Core.Text.Bytes

Methods

fromBytes :: Bytes -> Builder

intoBytes :: Builder -> Bytes

Binary ByteString

from Data.ByteString Strict

Defined in Core.Text.Bytes

Methods

fromBytes :: Bytes -> ByteString

intoBytes :: ByteString -> Bytes

Binary ByteString

from Data.ByteString.Lazy

Defined in Core.Text.Bytes

Methods

fromBytes :: Bytes -> ByteString

intoBytes :: ByteString -> Bytes

Binary Bytes

Defined in Core.Text.Bytes

Methods

fromBytes :: Bytes -> Bytes

intoBytes :: Bytes -> Bytes

Binary Rope

Defined in Core.Text.Rope

Methods

fromBytes :: Bytes -> Rope

intoBytes :: Rope -> Bytes

Binary [Word8]

from Data.Word

Defined in Core.Text.Bytes

Methods

fromBytes :: Bytes -> [Word8]

intoBytes :: [Word8] -> Bytes

hOutput :: Handle -> Bytes -> IO ()

Output the content of the Bytes to the specified Handle.

    hOutput h b

outputEntire provides a convenient way to write a Bytes to a file or socket handle from within the Program monad.

Don't use this function to write to stdout if you are using any of the other output or logging facililities of this libarary as you will corrupt the ordering of output on the user's terminal. Instead do:

    write (intoRope b)

on the assumption that the bytes in question are UTF-8 (or plain ASCII) encoded.

hInput :: Handle -> IO Bytes

Read the (entire) contents of a handle into a Bytes object.

If you want to read the entire contents of a file, you can do:

    contents <- withFile name ReadMode hInput

At any kind of scale, Streaming I/O is almost always for better, but for small files you need to pick apart this is fine.

Internals

unBytes :: Bytes -> ByteString

Access the strict ByteString underlying the Bytes type.