Codec.Base64

This module provides access to the "base64" binary-to-text encoding as defined by RFC 4648.

This module is intended to be imported qualified, e.g.

import qualified Codec.Base64 as B64

If you want to explictly specify which Encode and Decode typeclass instance is used, you can use plain Haskell2010 type-signature annotations, e.g.

>>> (B64.encode :: ByteString -> Text) "\x00\x00"
"AAA="

>>> (B64.decode :: Text -> Either String ShortByteString) "NDoyMA=="
Right "4:20"

Alternatively, starting with GHC 8.0.1, you can also use the TypeApplications language extension:

>>> B64.encode @ShortByteString @Text "\xFF\239"
"/+8="

>>> B64.decode @Text @ShortByteString "/+8="
Right "\255\239"

Since: 0.1.0.0

Documentation

class Encode bin txt where

Typeclass representing types for which a binary-to-text base64 encoding is defined

Minimal complete definition

encode

Methods

encode :: bin -> txt

Encode binary data using base64 text encoding

Instances

Encode ShortByteString ShortByteString

Methods

encode :: ShortByteString -> ShortByteString

Encode ShortByteString ByteString

Methods

encode :: ShortByteString -> ByteString

Encode ShortByteString ByteString

Methods

encode :: ShortByteString -> ByteString

Encode ShortByteString Builder

Methods

encode :: ShortByteString -> Builder

Encode ShortByteString Builder

Methods

encode :: ShortByteString -> Builder

Encode ShortByteString Text

Methods

encode :: ShortByteString -> Text

Encode ShortByteString Text

Methods

encode :: ShortByteString -> Text

Encode ByteString ShortByteString

Methods

encode :: ByteString -> ShortByteString

Encode ByteString ByteString

Methods

encode :: ByteString -> ByteString

Encode ByteString ByteString

Methods

encode :: ByteString -> ByteString

Encode ByteString Builder

Methods

encode :: ByteString -> Builder

Encode ByteString Builder

Methods

encode :: ByteString -> Builder

Encode ByteString Text

Methods

encode :: ByteString -> Text

Encode ByteString Text

Methods

encode :: ByteString -> Text

Encode ByteString ShortByteString

Methods

encode :: ByteString -> ShortByteString

Encode ByteString ByteString

Methods

encode :: ByteString -> ByteString

Encode ByteString ByteString

Methods

encode :: ByteString -> ByteString

Encode ByteString Builder

Methods

encode :: ByteString -> Builder

Encode ByteString Builder

Methods

encode :: ByteString -> Builder

Encode ByteString Text

Methods

encode :: ByteString -> Text

Encode ByteString Text

Methods

encode :: ByteString -> Text

Encode Builder ShortByteString

Methods

encode :: Builder -> ShortByteString

Encode Builder ByteString

Methods

encode :: Builder -> ByteString

Encode Builder ByteString

Methods

encode :: Builder -> ByteString

Encode Builder Builder

Methods

encode :: Builder -> Builder

Encode Builder Builder

Methods

encode :: Builder -> Builder

Encode Builder Text

Methods

encode :: Builder -> Text

Encode Builder Text

Methods

encode :: Builder -> Text

class Decode txt bin where

Typeclass representing types for which a text-to-binary base64 decoding is defined

Minimal complete definition

decode

Methods

decode :: txt -> Either String bin

Decode binary data encoded textually as base64

Instances

Decode ShortByteString ShortByteString

Methods

decode :: ShortByteString -> Either String ShortByteString

Decode ShortByteString ByteString

Methods

decode :: ShortByteString -> Either String ByteString

Decode ShortByteString ByteString

Methods

decode :: ShortByteString -> Either String ByteString

Decode ShortByteString Builder

Methods

decode :: ShortByteString -> Either String Builder

Decode ByteString ShortByteString

Methods

decode :: ByteString -> Either String ShortByteString

Decode ByteString ByteString

Methods

decode :: ByteString -> Either String ByteString

Decode ByteString ByteString

Methods

decode :: ByteString -> Either String ByteString

Decode ByteString Builder

Methods

decode :: ByteString -> Either String Builder

Decode ByteString ShortByteString

Methods

decode :: ByteString -> Either String ShortByteString

Decode ByteString ByteString

Methods

decode :: ByteString -> Either String ByteString

Decode ByteString ByteString

Methods

decode :: ByteString -> Either String ByteString

Decode ByteString Builder

Methods

decode :: ByteString -> Either String Builder

Decode Builder ShortByteString

Methods

decode :: Builder -> Either String ShortByteString

Decode Builder ByteString

Methods

decode :: Builder -> Either String ByteString

Decode Builder ByteString

Methods

decode :: Builder -> Either String ByteString

Decode Builder Builder

Methods

decode :: Builder -> Either String Builder

Decode Builder ShortByteString

Methods

decode :: Builder -> Either String ShortByteString

Decode Builder ByteString

Methods

decode :: Builder -> Either String ByteString

Decode Builder ByteString

Methods

decode :: Builder -> Either String ByteString

Decode Builder Builder

Methods

decode :: Builder -> Either String Builder

Decode Text ShortByteString

Methods

decode :: Text -> Either String ShortByteString

Decode Text ByteString

Methods

decode :: Text -> Either String ByteString

Decode Text ByteString

Methods

decode :: Text -> Either String ByteString

Decode Text Builder

Methods

decode :: Text -> Either String Builder

Decode Text ShortByteString

Methods

decode :: Text -> Either String ShortByteString

Decode Text ByteString

Methods

decode :: Text -> Either String ByteString

Decode Text ByteString

Methods

decode :: Text -> Either String ByteString

Decode Text Builder

Methods

decode :: Text -> Either String Builder