Copyright	Alexander Krupenkin 2018
License	BSD3
Maintainer	mail@akru.me
Stability	experimental
Portability	unportable
Safe Haskell	None
Language	Haskell2010

Data.ByteArray.HexString

Description

Hex string data type and useful functions.

Synopsis

newtype HexString = HexString {
- unHexString :: ByteString
}
hexString :: ByteArray ba => ba -> Either String HexString
fromBytes :: ByteArrayAccess ba => ba -> HexString
toBytes :: ByteArray ba => HexString -> ba
toText :: HexString -> Text

Documentation

newtype HexString Source #

Represents a Hex string. Guarantees that all characters it contains are valid hex characters.

Constructors

HexString
Fields unHexString :: ByteString

Instances

Eq HexString Source #
Instance details Defined in Data.ByteArray.HexString Methods (==) :: HexString -> HexString -> Bool # (/=) :: HexString -> HexString -> Bool #
Ord HexString Source #
Instance details Defined in Data.ByteArray.HexString Methods compare :: HexString -> HexString -> Ordering # (<) :: HexString -> HexString -> Bool # (<=) :: HexString -> HexString -> Bool # (>) :: HexString -> HexString -> Bool # (>=) :: HexString -> HexString -> Bool # max :: HexString -> HexString -> HexString # min :: HexString -> HexString -> HexString #
Show HexString Source #
Instance details Defined in Data.ByteArray.HexString Methods showsPrec :: Int -> HexString -> ShowS # show :: HexString -> String # showList :: [HexString] -> ShowS #
IsString HexString Source #
Instance details Defined in Data.ByteArray.HexString Methods fromString :: String -> HexString #
Semigroup HexString Source #
Instance details Defined in Data.ByteArray.HexString Methods (<>) :: HexString -> HexString -> HexString # sconcat :: NonEmpty HexString -> HexString # stimes :: Integral b => b -> HexString -> HexString #
Monoid HexString Source #
Instance details Defined in Data.ByteArray.HexString Methods mempty :: HexString # mappend :: HexString -> HexString -> HexString # mconcat :: [HexString] -> HexString #
ToJSON HexString Source #
Instance details Defined in Data.ByteArray.HexString Methods toJSON :: HexString -> Value # toEncoding :: HexString -> Encoding # toJSONList :: [HexString] -> Value # toEncodingList :: [HexString] -> Encoding #
FromJSON HexString Source #
Instance details Defined in Data.ByteArray.HexString Methods parseJSON :: Value -> Parser HexString # parseJSONList :: Value -> Parser [HexString] #
ByteArray HexString Source #
Instance details Defined in Data.ByteArray.HexString Methods allocRet :: Int -> (Ptr p -> IO a) -> IO (a, HexString) #
ByteArrayAccess HexString Source #
Instance details Defined in Data.ByteArray.HexString Methods length :: HexString -> Int # withByteArray :: HexString -> (Ptr p -> IO a) -> IO a # copyByteArrayToPtr :: HexString -> Ptr p -> IO () #

hexString :: ByteArray ba => ba -> Either String HexString Source #

Smart constructor which validates that all the text are actually have `0x` prefix, hexadecimal characters and length is even.

fromBytes :: ByteArrayAccess ba => ba -> HexString Source #

Reads a raw bytes and converts to hex representation.

toBytes :: ByteArray ba => HexString -> ba Source #

Access to the raw bytes of HexString.

toText :: HexString -> Text Source #

Access to a Text representation of the HexString