Data.ByteString.BaseN

Type-safe kitchen sink base-N encoding and decoding of strict ByteStrings.

Documentation

data Base (a :: Symbol) where

Supported bases.

Constructors

BaseIdentity :: Base "id"

Base2 :: Base "2"

Base16 :: Base "16"

Base64 :: Base "64"

Base16upper :: Base "16u"

hexadecimal, uppercase alphabet

Base32hex :: Base "32x"

RFC4648 no padding - highest char

Base32hexupper :: Base "32xu"

RFC4648 no padding - highest char, uppercase alphabet

Base32hexpad :: Base "32xp"

RFC4648 with padding

Base32hexpadupper :: Base "32xpu"

RFC4648 with padding, uppercase alphabet

Base32 :: Base "32"

RFC4648 no padding

Base32z :: Base "32z"

z-base-32 (used by Tahoe-LAFS)

Base32upper :: Base "32u"

RFC4648 no padding, uppercase alphabet

Base32pad :: Base "32p"

RFC4648 with padding

Base32padupper :: Base "32pu"

RFC4648 with padding, uppercase alphabet

Base58flickr :: Base "58flickr"

base58 flickr alphabet

Base58btc :: Base "58btc"

base58 bitcoint alphabet

Base64pad :: Base "64p"

RFC4648 with padding (MIME-encoding)

Base64url :: Base "64url"

RFC4648 no padding

Base64urlpad :: Base "64urlp"

RFC4648 with padding

data AtBase (b :: Symbol)

A ByteString encoded at a specific base.

Instances

Eq (AtBase b)

Defined in Data.ByteString.BaseN

Methods

(==) :: AtBase b -> AtBase b -> Bool

(/=) :: AtBase b -> AtBase b -> Bool

Ord (AtBase b)

Defined in Data.ByteString.BaseN

Methods

compare :: AtBase b -> AtBase b -> Ordering

(<) :: AtBase b -> AtBase b -> Bool

(<=) :: AtBase b -> AtBase b -> Bool

(>) :: AtBase b -> AtBase b -> Bool

(>=) :: AtBase b -> AtBase b -> Bool

max :: AtBase b -> AtBase b -> AtBase b

min :: AtBase b -> AtBase b -> AtBase b

KnownSymbol b => Show (AtBase b)

Defined in Data.ByteString.BaseN

Methods

showsPrec :: Int -> AtBase b -> ShowS

show :: AtBase b -> String

showList :: [AtBase b] -> ShowS

ValidBase b => IsString (AtBase b)

Defined in Data.ByteString.BaseN

Methods

fromString :: String -> AtBase b

Hashable (AtBase b)

Defined in Data.ByteString.BaseN

Methods

hashWithSalt :: Int -> AtBase b -> Int

hash :: AtBase b -> Int

ToJSON (AtBase b)

Defined in Data.ByteString.BaseN

Methods

toJSON :: AtBase b -> Value

toEncoding :: AtBase b -> Encoding

toJSONList :: [AtBase b] -> Value

toEncodingList :: [AtBase b] -> Encoding

ToJSONKey (AtBase b)

Defined in Data.ByteString.BaseN

Methods

toJSONKey :: ToJSONKeyFunction (AtBase b)

toJSONKeyList :: ToJSONKeyFunction [AtBase b]

(ValidBase b, KnownSymbol b) => FromJSON (AtBase b)

Defined in Data.ByteString.BaseN

Methods

parseJSON :: Value -> Parser (AtBase b)

parseJSONList :: Value -> Parser [AtBase b]

(ValidBase b, KnownSymbol b) => FromJSONKey (AtBase b)

Defined in Data.ByteString.BaseN

Methods

fromJSONKey :: FromJSONKeyFunction (AtBase b)

fromJSONKeyList :: FromJSONKeyFunction [AtBase b]

NFData (AtBase b)

Defined in Data.ByteString.BaseN

Methods

rnf :: AtBase b -> ()

encodedBytes :: AtBase b -> ByteString

Extract the base-n encoded bytes from an AtBase.

To recover the original ByteString (*not* base-n encoded), use decode.

encodedBuilder :: AtBase b -> Builder

Like encodedBytes, but return a Builder.

type Base2 = AtBase "2"

type Base16 = AtBase "16"

type Base58 = AtBase "58"

type Base64 = AtBase "64"

type BaseIdentity = AtBase "id"

type Base16upper = AtBase "16u"

type Base32hex = AtBase "16x"

type Base32hexupper = AtBase "16xu"

type Base32hexpad = AtBase "16xp"

type Base32hexpadupper = AtBase "16xup"

type Base32 = AtBase "32"

type Base32z = AtBase "32z"

type Base32upper = AtBase "32u"

type Base32pad = AtBase "32p"

type Base32padupper = AtBase "32pu"

type Base58flickr = AtBase "58flickr"

type Base58btc = AtBase "58btc"

type Base64pad = AtBase "64p"

type Base64url = AtBase "64url"

type Base64urlpad = AtBase "16urlp"

Compact Representation

data AtBaseCompact (b :: Symbol)

A more memory-efficient representation of base-n encoded bytes.

Uses ShortByteString, recommendations and caveats described there apply.

Instances

Eq (AtBaseCompact b)

Defined in Data.ByteString.BaseN

Methods

(==) :: AtBaseCompact b -> AtBaseCompact b -> Bool

(/=) :: AtBaseCompact b -> AtBaseCompact b -> Bool

Ord (AtBaseCompact b)

Defined in Data.ByteString.BaseN

Methods

compare :: AtBaseCompact b -> AtBaseCompact b -> Ordering

(<) :: AtBaseCompact b -> AtBaseCompact b -> Bool

(<=) :: AtBaseCompact b -> AtBaseCompact b -> Bool

(>) :: AtBaseCompact b -> AtBaseCompact b -> Bool

(>=) :: AtBaseCompact b -> AtBaseCompact b -> Bool

max :: AtBaseCompact b -> AtBaseCompact b -> AtBaseCompact b

min :: AtBaseCompact b -> AtBaseCompact b -> AtBaseCompact b

KnownSymbol b => Show (AtBaseCompact b)

Defined in Data.ByteString.BaseN

Methods

showsPrec :: Int -> AtBaseCompact b -> ShowS

show :: AtBaseCompact b -> String

showList :: [AtBaseCompact b] -> ShowS

Hashable (AtBaseCompact b)

Defined in Data.ByteString.BaseN

Methods

hashWithSalt :: Int -> AtBaseCompact b -> Int

hash :: AtBaseCompact b -> Int

NFData (AtBaseCompact b)

Defined in Data.ByteString.BaseN

Methods

rnf :: AtBaseCompact b -> ()

compact :: AtBase b -> AtBaseCompact b

expand :: AtBaseCompact b -> AtBase b

Tagged

AtBase values tagged by the type they're representing.

type Base16Of a = Tagged a (AtBase "16")

type Base58Of a = Tagged a (AtBase "58")

type Base64Of a = Tagged a (AtBase "64")

Re-exports

tagWith :: proxy s -> a -> Tagged s a

Another way to convert a proxy to a tag.

unTagged :: Tagged s b -> b

CBOR

Directly go from (presumed to be) base-n encoded ByteString to de-Serialise-able value.

data DeserialiseError

Constructors

DecodeBaseError String

DeserialiseError DeserialiseFailure

Instances

Show DeserialiseError

Defined in Data.ByteString.BaseN

Methods

showsPrec :: Int -> DeserialiseError -> ShowS

show :: DeserialiseError -> String

showList :: [DeserialiseError] -> ShowS

deserialiseAtBase :: (Serialise a, DecodeBase b) => proxy b -> ByteString -> Either DeserialiseError a

Encoding

encodeBase16 :: ByteString -> AtBase "16"

encodeBase58btc :: ByteString -> AtBase "58btc"

>>> fromAtBase . encodeBase58btc $ "hello world"
"StV1DL6CwTryKyV"

encodeBase64 :: ByteString -> AtBase "64"

encodeAtBase :: Base b -> ByteString -> AtBase b

Encode at a base supplied at runtime.

Decoding Bytes

Decode (presumed to be) base-n encoded ByteStrings to their original (base-2) value.

class DecodeBase (b :: Symbol)

Minimal complete definition

decodeAtBase, decodeAtBaseEither

Instances

DecodeBase "16"

Defined in Data.ByteString.BaseN

Methods

decodeAtBase :: proxy "16" -> ByteString -> Maybe ByteString

decodeAtBaseEither :: proxy "16" -> ByteString -> Either String ByteString

DecodeBase "16u"

Defined in Data.ByteString.BaseN

Methods

decodeAtBase :: proxy "16u" -> ByteString -> Maybe ByteString

decodeAtBaseEither :: proxy "16u" -> ByteString -> Either String ByteString

DecodeBase "2"

Defined in Data.ByteString.BaseN

Methods

decodeAtBase :: proxy "2" -> ByteString -> Maybe ByteString

decodeAtBaseEither :: proxy "2" -> ByteString -> Either String ByteString

DecodeBase "32"

Defined in Data.ByteString.BaseN

Methods

decodeAtBase :: proxy "32" -> ByteString -> Maybe ByteString

decodeAtBaseEither :: proxy "32" -> ByteString -> Either String ByteString

DecodeBase "32p"

Defined in Data.ByteString.BaseN

Methods

decodeAtBase :: proxy "32p" -> ByteString -> Maybe ByteString

decodeAtBaseEither :: proxy "32p" -> ByteString -> Either String ByteString

DecodeBase "32pu"

Defined in Data.ByteString.BaseN

Methods

decodeAtBase :: proxy "32pu" -> ByteString -> Maybe ByteString

decodeAtBaseEither :: proxy "32pu" -> ByteString -> Either String ByteString

DecodeBase "32u"

Defined in Data.ByteString.BaseN

Methods

decodeAtBase :: proxy "32u" -> ByteString -> Maybe ByteString

decodeAtBaseEither :: proxy "32u" -> ByteString -> Either String ByteString

DecodeBase "32x"

Defined in Data.ByteString.BaseN

Methods

decodeAtBase :: proxy "32x" -> ByteString -> Maybe ByteString

decodeAtBaseEither :: proxy "32x" -> ByteString -> Either String ByteString

DecodeBase "32xp"

Defined in Data.ByteString.BaseN

Methods

decodeAtBase :: proxy "32xp" -> ByteString -> Maybe ByteString

decodeAtBaseEither :: proxy "32xp" -> ByteString -> Either String ByteString

DecodeBase "32xpu"

Defined in Data.ByteString.BaseN

Methods

decodeAtBase :: proxy "32xpu" -> ByteString -> Maybe ByteString

decodeAtBaseEither :: proxy "32xpu" -> ByteString -> Either String ByteString

DecodeBase "32xu"

Defined in Data.ByteString.BaseN

Methods

decodeAtBase :: proxy "32xu" -> ByteString -> Maybe ByteString

decodeAtBaseEither :: proxy "32xu" -> ByteString -> Either String ByteString

DecodeBase "32z"

Defined in Data.ByteString.BaseN

Methods

decodeAtBase :: proxy "32z" -> ByteString -> Maybe ByteString

decodeAtBaseEither :: proxy "32z" -> ByteString -> Either String ByteString

DecodeBase "58btc"

Defined in Data.ByteString.BaseN

Methods

decodeAtBase :: proxy "58btc" -> ByteString -> Maybe ByteString

decodeAtBaseEither :: proxy "58btc" -> ByteString -> Either String ByteString

DecodeBase "58flickr"

Defined in Data.ByteString.BaseN

Methods

decodeAtBase :: proxy "58flickr" -> ByteString -> Maybe ByteString

decodeAtBaseEither :: proxy "58flickr" -> ByteString -> Either String ByteString

DecodeBase "64"

Defined in Data.ByteString.BaseN

Methods

decodeAtBase :: proxy "64" -> ByteString -> Maybe ByteString

decodeAtBaseEither :: proxy "64" -> ByteString -> Either String ByteString

DecodeBase "64p"

Defined in Data.ByteString.BaseN

Methods

decodeAtBase :: proxy "64p" -> ByteString -> Maybe ByteString

decodeAtBaseEither :: proxy "64p" -> ByteString -> Either String ByteString

DecodeBase "64url"

Defined in Data.ByteString.BaseN

Methods

decodeAtBase :: proxy "64url" -> ByteString -> Maybe ByteString

decodeAtBaseEither :: proxy "64url" -> ByteString -> Either String ByteString

DecodeBase "64urlpad"

Defined in Data.ByteString.BaseN

Methods

decodeAtBase :: proxy "64urlpad" -> ByteString -> Maybe ByteString

decodeAtBaseEither :: proxy "64urlpad" -> ByteString -> Either String ByteString

DecodeBase "id"

Defined in Data.ByteString.BaseN

Methods

decodeAtBase :: proxy "id" -> ByteString -> Maybe ByteString

decodeAtBaseEither :: proxy "id" -> ByteString -> Either String ByteString

decodeBase16 :: ByteString -> Maybe ByteString

decodeBase16Either :: ByteString -> Either String ByteString

decodeBase58btc :: ByteString -> Either String ByteString

\(Bytes bytes) -> decodeBase58btc (fromAtBase $ encodeBase58btc bytes) === Right bytes

decodeBase64 :: ByteString -> Maybe ByteString

decodeBase64Either :: ByteString -> Either String ByteString

decodeBase64Lenient :: ByteString -> ByteString

decodeAtBase :: DecodeBase b => proxy b -> ByteString -> Maybe ByteString

decodeAtBaseEither :: DecodeBase b => proxy b -> ByteString -> Either String ByteString

Decoding

decode :: DecodeBase b => AtBase b -> ByteString

Recover the original ByteString of a base-n encoded value.

Untrusted Input

Construct AtBases from raw ByteStrings. Note that this attempts to decode using the functions from $decoding, and throws away the result.

class KnownSymbol b => ValidBase (b :: Symbol)

Minimal complete definition

validAtBase, validAtBaseEither

Instances

ValidBase "16"

Defined in Data.ByteString.BaseN

Methods

validAtBase :: proxy "16" -> ByteString -> Maybe (AtBase "16")

validAtBaseEither :: proxy "16" -> ByteString -> Either String (AtBase "16")

ValidBase "16u"

Defined in Data.ByteString.BaseN

Methods

validAtBase :: proxy "16u" -> ByteString -> Maybe (AtBase "16u")

validAtBaseEither :: proxy "16u" -> ByteString -> Either String (AtBase "16u")

ValidBase "2"

Defined in Data.ByteString.BaseN

Methods

validAtBase :: proxy "2" -> ByteString -> Maybe (AtBase "2")

validAtBaseEither :: proxy "2" -> ByteString -> Either String (AtBase "2")

ValidBase "32"

Defined in Data.ByteString.BaseN

Methods

validAtBase :: proxy "32" -> ByteString -> Maybe (AtBase "32")

validAtBaseEither :: proxy "32" -> ByteString -> Either String (AtBase "32")

ValidBase "32p"

Defined in Data.ByteString.BaseN

Methods

validAtBase :: proxy "32p" -> ByteString -> Maybe (AtBase "32p")

validAtBaseEither :: proxy "32p" -> ByteString -> Either String (AtBase "32p")

ValidBase "32pu"

Defined in Data.ByteString.BaseN

Methods

validAtBase :: proxy "32pu" -> ByteString -> Maybe (AtBase "32pu")

validAtBaseEither :: proxy "32pu" -> ByteString -> Either String (AtBase "32pu")

ValidBase "32u"

Defined in Data.ByteString.BaseN

Methods

validAtBase :: proxy "32u" -> ByteString -> Maybe (AtBase "32u")

validAtBaseEither :: proxy "32u" -> ByteString -> Either String (AtBase "32u")

ValidBase "32x"

Defined in Data.ByteString.BaseN

Methods

validAtBase :: proxy "32x" -> ByteString -> Maybe (AtBase "32x")

validAtBaseEither :: proxy "32x" -> ByteString -> Either String (AtBase "32x")

ValidBase "32xp"

Defined in Data.ByteString.BaseN

Methods

validAtBase :: proxy "32xp" -> ByteString -> Maybe (AtBase "32xp")

validAtBaseEither :: proxy "32xp" -> ByteString -> Either String (AtBase "32xp")

ValidBase "32xpu"

Defined in Data.ByteString.BaseN

Methods

validAtBase :: proxy "32xpu" -> ByteString -> Maybe (AtBase "32xpu")

validAtBaseEither :: proxy "32xpu" -> ByteString -> Either String (AtBase "32xpu")

ValidBase "32xu"

Defined in Data.ByteString.BaseN

Methods

validAtBase :: proxy "32xu" -> ByteString -> Maybe (AtBase "32xu")

validAtBaseEither :: proxy "32xu" -> ByteString -> Either String (AtBase "32xu")

ValidBase "32z"

Defined in Data.ByteString.BaseN

Methods

validAtBase :: proxy "32z" -> ByteString -> Maybe (AtBase "32z")

validAtBaseEither :: proxy "32z" -> ByteString -> Either String (AtBase "32z")

ValidBase "58btc"

Defined in Data.ByteString.BaseN

Methods

validAtBase :: proxy "58btc" -> ByteString -> Maybe (AtBase "58btc")

validAtBaseEither :: proxy "58btc" -> ByteString -> Either String (AtBase "58btc")

ValidBase "58flickr"

Defined in Data.ByteString.BaseN

Methods

validAtBase :: proxy "58flickr" -> ByteString -> Maybe (AtBase "58flickr")

validAtBaseEither :: proxy "58flickr" -> ByteString -> Either String (AtBase "58flickr")

ValidBase "64"

Defined in Data.ByteString.BaseN

Methods

validAtBase :: proxy "64" -> ByteString -> Maybe (AtBase "64")

validAtBaseEither :: proxy "64" -> ByteString -> Either String (AtBase "64")

ValidBase "64p"

Defined in Data.ByteString.BaseN

Methods

validAtBase :: proxy "64p" -> ByteString -> Maybe (AtBase "64p")

validAtBaseEither :: proxy "64p" -> ByteString -> Either String (AtBase "64p")

ValidBase "64url"

Defined in Data.ByteString.BaseN

Methods

validAtBase :: proxy "64url" -> ByteString -> Maybe (AtBase "64url")

validAtBaseEither :: proxy "64url" -> ByteString -> Either String (AtBase "64url")

ValidBase "64urlpad"

Defined in Data.ByteString.BaseN

Methods

validAtBase :: proxy "64urlpad" -> ByteString -> Maybe (AtBase "64urlpad")

validAtBaseEither :: proxy "64urlpad" -> ByteString -> Either String (AtBase "64urlpad")

ValidBase "id"

Defined in Data.ByteString.BaseN

Methods

validAtBase :: proxy "id" -> ByteString -> Maybe (AtBase "id")

validAtBaseEither :: proxy "id" -> ByteString -> Either String (AtBase "id")

validBase16 :: ByteString -> Maybe (AtBase "16")

validBase16Either :: ByteString -> Either String (AtBase "16")

validBase58btc :: ByteString -> Maybe (AtBase "58btc")

validBase58btcEither :: ByteString -> Either String (AtBase "58btc")

validBase64 :: ByteString -> Maybe (AtBase "64")

validBase64Either :: ByteString -> Either String (AtBase "64")

validAtBase :: ValidBase b => proxy b -> ByteString -> Maybe (AtBase b)

validAtBaseEither :: ValidBase b => proxy b -> ByteString -> Either String (AtBase b)

validAndDecoded :: DecodeBase b => proxy b -> ByteString -> Maybe (AtBase b, ByteString)

Like validAtBase, but also return the decoded ByteString.

validAndDecodedEither :: DecodeBase b => proxy b -> ByteString -> Either String (AtBase b, ByteString)

Like validAtBaseEither, but also return the decoded ByteString.

Text

encodedTextAtBase :: Base b -> Text -> AtBase b

Like encodeAtBase, but from a Text value.

encodedText :: AtBase b -> Text

Like encodedBytes, but returns a Text value.

encodedTextBuilder :: AtBase b -> Builder

Like encodedBuilder, but returns a text Builder.

Formatting

format :: Format r (AtBase b -> r)

Format a base-n encoded value.

formatAtBase :: Format r (AtBase b -> r)

Format a base-n encoded value.