Z.Data.Vector.Base64

This module provides base64 encoding & decoding tools, as well as Base64Bytes newtype with base64 textual instances.

The Base64Bytes type

newtype Base64Bytes

New type wrapper for Bytes with base64 encoding Show/JSON instances.

Constructors

Base64Bytes

Fields

• unBase64Bytes :: Bytes

Instances

Eq Base64Bytes

Defined in Z.Data.Vector.Base64

Methods

(==) :: Base64Bytes -> Base64Bytes -> Bool

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

Ord Base64Bytes

Defined in Z.Data.Vector.Base64

Methods

compare :: Base64Bytes -> Base64Bytes -> Ordering

(<) :: Base64Bytes -> Base64Bytes -> Bool

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

(>) :: Base64Bytes -> Base64Bytes -> Bool

(>=) :: Base64Bytes -> Base64Bytes -> Bool

max :: Base64Bytes -> Base64Bytes -> Base64Bytes

min :: Base64Bytes -> Base64Bytes -> Base64Bytes

Show Base64Bytes

Defined in Z.Data.Vector.Base64

Methods

showsPrec :: Int -> Base64Bytes -> ShowS

show :: Base64Bytes -> String

showList :: [Base64Bytes] -> ShowS

Semigroup Base64Bytes

Defined in Z.Data.Vector.Base64

Methods

(<>) :: Base64Bytes -> Base64Bytes -> Base64Bytes

sconcat :: NonEmpty Base64Bytes -> Base64Bytes

stimes :: Integral b => b -> Base64Bytes -> Base64Bytes

Monoid Base64Bytes

Defined in Z.Data.Vector.Base64

Methods

mempty :: Base64Bytes

mappend :: Base64Bytes -> Base64Bytes -> Base64Bytes

mconcat :: [Base64Bytes] -> Base64Bytes

Hashable Base64Bytes

Defined in Z.Data.Vector.Base64

Methods

hashWithSalt :: Int -> Base64Bytes -> Int

hash :: Base64Bytes -> Int

Print Base64Bytes

Defined in Z.Data.Vector.Base64

Methods

toUTF8BuilderP :: Int -> Base64Bytes -> Builder ()

JSON Base64Bytes

Defined in Z.Data.Vector.Base64

Methods

fromValue :: Value -> Converter Base64Bytes

toValue :: Base64Bytes -> Value

encodeJSON :: Base64Bytes -> Builder ()

Encoding & Decoding functions

base64Encode :: Bytes -> Bytes

Encode Bytes using base64 encoding.

base64EncodeLength :: Int -> Int

Return the encoded length of a given input length, always a multipler of 4.

base64EncodeText :: Bytes -> Text

Text version of base64Encode.

base64EncodeBuilder :: Bytes -> Builder ()

Builder version of base64Encode.

base64Decode :: Bytes -> Maybe Bytes

Decode a base64 encoding string, return Nothing on illegal bytes or incomplete input.

base64Decode' :: HasCallStack => Bytes -> Bytes

Decode a base64 encoding string, throw Base64DecodeException on error.

base64DecodeLength :: Int -> Int

Return the upper bound of decoded length of a given input length , return -1 if illegal(not a multipler of 4).

data Base64DecodeException

Exception during base64 decoding.

Constructors

IllegalBase64Bytes Bytes CallStack

IncompleteBase64Bytes Bytes CallStack

Instances

Show Base64DecodeException

Defined in Z.Data.Vector.Base64

Methods

showsPrec :: Int -> Base64DecodeException -> ShowS

show :: Base64DecodeException -> String

showList :: [Base64DecodeException] -> ShowS

Exception Base64DecodeException

Defined in Z.Data.Vector.Base64

Methods

toException :: Base64DecodeException -> SomeException

fromException :: SomeException -> Maybe Base64DecodeException

displayException :: Base64DecodeException -> String

Internal C FFIs

hs_base64_encode :: MBA# Word8 -> Int -> BA# Word8 -> Int -> Int -> IO ()

hs_base64_decode :: MBA# Word8 -> BA# Word8 -> Int -> Int -> IO Int