Data.ByteString.Multibase

multibase encoding of strict ByteStrings.

Supported bases

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

class ValidBase b => ToCode b

Symbols for which a multibase code is defined and supported by this library

Minimal complete definition

toCode

Instances

ToCode "16"

Defined in Data.ByteString.Multibase

Methods

toCode :: proxy "16" -> Char

ToCode "16u"

Defined in Data.ByteString.Multibase

Methods

toCode :: proxy "16u" -> Char

ToCode "32"

Defined in Data.ByteString.Multibase

Methods

toCode :: proxy "32" -> Char

ToCode "32p"

Defined in Data.ByteString.Multibase

Methods

toCode :: proxy "32p" -> Char

ToCode "32pu"

Defined in Data.ByteString.Multibase

Methods

toCode :: proxy "32pu" -> Char

ToCode "32u"

Defined in Data.ByteString.Multibase

Methods

toCode :: proxy "32u" -> Char

ToCode "32x"

Defined in Data.ByteString.Multibase

Methods

toCode :: proxy "32x" -> Char

ToCode "32xp"

Defined in Data.ByteString.Multibase

Methods

toCode :: proxy "32xp" -> Char

ToCode "32xpu"

Defined in Data.ByteString.Multibase

Methods

toCode :: proxy "32xpu" -> Char

ToCode "32xu"

Defined in Data.ByteString.Multibase

Methods

toCode :: proxy "32xu" -> Char

ToCode "32z"

Defined in Data.ByteString.Multibase

Methods

toCode :: proxy "32z" -> Char

ToCode "58btc"

Defined in Data.ByteString.Multibase

Methods

toCode :: proxy "58btc" -> Char

ToCode "58flickr"

Defined in Data.ByteString.Multibase

Methods

toCode :: proxy "58flickr" -> Char

ToCode "64"

Defined in Data.ByteString.Multibase

Methods

toCode :: proxy "64" -> Char

ToCode "64p"

Defined in Data.ByteString.Multibase

Methods

toCode :: proxy "64p" -> Char

ToCode "64url"

Defined in Data.ByteString.Multibase

Methods

toCode :: proxy "64url" -> Char

ToCode "64urlpad"

Defined in Data.ByteString.Multibase

Methods

toCode :: proxy "64urlpad" -> Char

ToCode "id"

Defined in Data.ByteString.Multibase

Methods

toCode :: proxy "id" -> Char

Multibase encoding and decoding

data Multibase

A multibase-encoded strict ByteString.

Instances

Eq Multibase

Defined in Data.ByteString.Multibase

Methods

(==) :: Multibase -> Multibase -> Bool

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

Ord Multibase

Defined in Data.ByteString.Multibase

Methods

compare :: Multibase -> Multibase -> Ordering

(<) :: Multibase -> Multibase -> Bool

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

(>) :: Multibase -> Multibase -> Bool

(>=) :: Multibase -> Multibase -> Bool

max :: Multibase -> Multibase -> Multibase

min :: Multibase -> Multibase -> Multibase

Hashable Multibase

Defined in Data.ByteString.Multibase

Methods

hashWithSalt :: Int -> Multibase -> Int

hash :: Multibase -> Int

NFData Multibase

Defined in Data.ByteString.Multibase

Methods

rnf :: Multibase -> ()

fromMultibase :: Multibase -> ByteString

Extract the encoded bytes, including the code Char, from a Multibase.

encodedBytes :: Multibase -> ByteString

Extract the encoded bytes from a Multibase.

The code Char signifying the base is stripped.

encode :: ToCode b => AtBase b -> Multibase

Encode a strict ByteString at Base.

decode :: ByteString -> Either String ByteString

Decode a strict ByteString, assumed to be Multibase-encoded.

Compact represenation

data CompactMultibase

A 'Multibase backed by a ShortByteString.

This is useful when holding many Multibase values in memory, due to lower memory overhead and less heap fragmentation. See the documentation for ShortByteString for details.

Instances

Eq CompactMultibase

Defined in Data.ByteString.Multibase

Methods

(==) :: CompactMultibase -> CompactMultibase -> Bool

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

Ord CompactMultibase

Defined in Data.ByteString.Multibase

Methods

compare :: CompactMultibase -> CompactMultibase -> Ordering

(<) :: CompactMultibase -> CompactMultibase -> Bool

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

(>) :: CompactMultibase -> CompactMultibase -> Bool

(>=) :: CompactMultibase -> CompactMultibase -> Bool

max :: CompactMultibase -> CompactMultibase -> CompactMultibase

min :: CompactMultibase -> CompactMultibase -> CompactMultibase

Hashable CompactMultibase

Defined in Data.ByteString.Multibase

Methods

hashWithSalt :: Int -> CompactMultibase -> Int

hash :: CompactMultibase -> Int

NFData CompactMultibase

Defined in Data.ByteString.Multibase

Methods

rnf :: CompactMultibase -> ()

compact :: Multibase -> CompactMultibase

O(n). Convert a Multibase encoding to a compact representation.

Involves copying the underlying ByteString.

expand :: CompactMultibase -> Multibase

O(n). Convert from the compact to the regular representation.

Involves copying the underlying ShortByteString.