Copyright	(c) Dong Han 2017-2018
License	BSD
Maintainer	winterland1989@gmail.com
Stability	experimental
Portability	non-portable
Safe Haskell	None
Language	Haskell2010

Z.Data.Vector.Hex

Contents

The HexBytes type
Encoding & Decoding functions
Internal C FFIs

Description

This module provides hex encoding & decoding tools, as well as HexBytes newtype with hex textual instances.

Synopsis

newtype HexBytes = HexBytes {
- unHexBytes :: Bytes
}
hexEncode :: Bool -> Bytes -> Bytes
hexEncodeText :: Bool -> Bytes -> Text
hexEncodeBuilder :: Bool -> Bytes -> Builder ()
hexDecode :: Bytes -> Maybe Bytes
hexDecode' :: HasCallStack => Bytes -> Bytes
data HexDecodeException
- = IllegalHexBytes Bytes CallStack
- | IncompleteHexBytes Bytes CallStack
hs_hex_encode :: MBA# Word8 -> Int -> BA# Word8 -> Int -> Int -> IO ()
hs_hex_encode_upper :: MBA# Word8 -> Int -> BA# Word8 -> Int -> Int -> IO ()
hs_hex_decode :: MBA# Word8 -> BA# Word8 -> Int -> Int -> IO Int

The HexBytes type

newtype HexBytes Source #

New type wrapper for Bytes with hex encoding(uppercase) Show/JSON instances.

Constructors

HexBytes
Fields unHexBytes :: Bytes

Instances

Instances details

Eq HexBytes Source #
Instance details Defined in Z.Data.Vector.Hex Methods (==) :: HexBytes -> HexBytes -> Bool # (/=) :: HexBytes -> HexBytes -> Bool #
Ord HexBytes Source #
Instance details Defined in Z.Data.Vector.Hex Methods compare :: HexBytes -> HexBytes -> Ordering # (<) :: HexBytes -> HexBytes -> Bool # (<=) :: HexBytes -> HexBytes -> Bool # (>) :: HexBytes -> HexBytes -> Bool # (>=) :: HexBytes -> HexBytes -> Bool # max :: HexBytes -> HexBytes -> HexBytes # min :: HexBytes -> HexBytes -> HexBytes #
Show HexBytes Source #
Instance details Defined in Z.Data.Vector.Hex Methods showsPrec :: Int -> HexBytes -> ShowS # show :: HexBytes -> String # showList :: [HexBytes] -> ShowS #
Semigroup HexBytes Source #
Instance details Defined in Z.Data.Vector.Hex Methods (<>) :: HexBytes -> HexBytes -> HexBytes # sconcat :: NonEmpty HexBytes -> HexBytes # stimes :: Integral b => b -> HexBytes -> HexBytes #
Monoid HexBytes Source #
Instance details Defined in Z.Data.Vector.Hex Methods mempty :: HexBytes # mappend :: HexBytes -> HexBytes -> HexBytes # mconcat :: [HexBytes] -> HexBytes #
Hashable HexBytes Source #
Instance details Defined in Z.Data.Vector.Hex Methods hashWithSalt :: Int -> HexBytes -> Int # hash :: HexBytes -> Int #
ShowT HexBytes Source #
Instance details Defined in Z.Data.Vector.Hex Methods toUTF8BuilderP :: Int -> HexBytes -> Builder () Source #
FromValue HexBytes Source #
Instance details Defined in Z.Data.Vector.Hex Methods fromValue :: Value -> Converter HexBytes Source #
EncodeJSON HexBytes Source #
Instance details Defined in Z.Data.Vector.Hex Methods encodeJSON :: HexBytes -> Builder () Source #
ToValue HexBytes Source #
Instance details Defined in Z.Data.Vector.Hex Methods toValue :: HexBytes -> Value Source #

Encoding & Decoding functions

hexEncode Source #

Arguments

:: Bool	uppercase?
-> Bytes
-> Bytes

Encode Bytes using hex(base16) encoding.

hexEncodeText Source #

Arguments

:: Bool	uppercase?
-> Bytes
-> Text

Text version of hexEncode.

hexEncodeBuilder Source #

Arguments

:: Bool	uppercase?
-> Bytes
-> Builder ()

Builder version of hexEncode.

hexDecode :: Bytes -> Maybe Bytes Source #

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

hexDecode' :: HasCallStack => Bytes -> Bytes Source #

Decode a hex encoding string, throw HexDecodeException on error.

data HexDecodeException Source #

Exception during hex decoding.

Constructors

IllegalHexBytes Bytes CallStack
IncompleteHexBytes Bytes CallStack

Instances

Instances details

Show HexDecodeException Source #
Instance details Defined in Z.Data.Vector.Hex Methods showsPrec :: Int -> HexDecodeException -> ShowS # show :: HexDecodeException -> String # showList :: [HexDecodeException] -> ShowS #
Exception HexDecodeException Source #
Instance details Defined in Z.Data.Vector.Hex Methods toException :: HexDecodeException -> SomeException # fromException :: SomeException -> Maybe HexDecodeException # displayException :: HexDecodeException -> String #

Internal C FFIs

hs_hex_encode :: MBA# Word8 -> Int -> BA# Word8 -> Int -> Int -> IO () Source #

hs_hex_encode_upper :: MBA# Word8 -> Int -> BA# Word8 -> Int -> Int -> IO () Source #

hs_hex_decode :: MBA# Word8 -> BA# Word8 -> Int -> Int -> IO Int Source #