Z.Data.Vector.Hex

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

The HexBytes type

newtype HexBytes

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

Constructors

HexBytes

Fields

• unHexBytes :: Bytes

Instances

JSON HexBytes

Defined in Z.Data.Vector.Hex

Methods

fromValue :: Value -> Converter HexBytes

toValue :: HexBytes -> Value

encodeJSON :: HexBytes -> Builder ()

Print HexBytes

Defined in Z.Data.Vector.Hex

Methods

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

Monoid HexBytes

Defined in Z.Data.Vector.Hex

Methods

mempty :: HexBytes

mappend :: HexBytes -> HexBytes -> HexBytes

mconcat :: [HexBytes] -> HexBytes

Semigroup HexBytes

Defined in Z.Data.Vector.Hex

Methods

(<>) :: HexBytes -> HexBytes -> HexBytes

sconcat :: NonEmpty HexBytes -> HexBytes

stimes :: Integral b => b -> HexBytes -> HexBytes

Show HexBytes

Defined in Z.Data.Vector.Hex

Methods

showsPrec :: Int -> HexBytes -> ShowS

show :: HexBytes -> String

showList :: [HexBytes] -> ShowS

Eq HexBytes

Defined in Z.Data.Vector.Hex

Methods

(==) :: HexBytes -> HexBytes -> Bool

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

Ord HexBytes

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

Hashable HexBytes

Defined in Z.Data.Vector.Hex

Methods

hashWithSalt :: Int -> HexBytes -> Int

hash :: HexBytes -> Int

Encoding & Decoding functions

hexEncode

Arguments

:: Bool

uppercase?

-> Bytes

-> Bytes

Encode Bytes using hex(base16) encoding.

hexEncodeText

Arguments

:: Bool

uppercase?

-> Bytes

-> Text

Text version of hexEncode.

hexEncodeBuilder

Arguments

:: Bool

uppercase?

-> Bytes

-> Builder ()

Builder version of hexEncode.

hexDecode :: Bytes -> Maybe Bytes

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

hexDecode' :: HasCallStack => Bytes -> Bytes

Decode a hex encoding string, throw HexDecodeException on error.

hexDecodeWS :: Bytes -> Maybe Bytes

Decode a hex encoding string, ignore ASCII whitespace(space, tab, newline, vertical tab, form feed, carriage return).

This is useful when you get some hex nibbles by pasting from web, note only whitesapces between bytes(two nibbles) are allowed:

>>> hexDecodeWS "6f7481 da0e53"
Just [111,116,129,218,14,83]
>>> hexDecodeWS "6f7481d a0e53"
Nothing

hexDecodeWS' :: HasCallStack => Bytes -> Bytes

Decode a hex encoding string, ignore ASCII whitespace(space, tab, newline, vertical tab, form feed, carriage return), throw HexDecodeException on error.

data HexDecodeException

Exception during hex decoding.

Constructors

IllegalHexBytes Bytes CallStack

IncompleteHexBytes Bytes CallStack

Instances

Exception HexDecodeException

Defined in Z.Data.Vector.Hex

Methods

toException :: HexDecodeException -> SomeException

fromException :: SomeException -> Maybe HexDecodeException

displayException :: HexDecodeException -> String

Show HexDecodeException

Defined in Z.Data.Vector.Hex

Methods

showsPrec :: Int -> HexDecodeException -> ShowS

show :: HexDecodeException -> String

showList :: [HexDecodeException] -> ShowS

Internal C FFIs

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