-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | Hex-string type for Haskell Web3 library.
--   
--   Client library for Third Generation of Web.
@package memory-hexstring
@version 1.0.0.0


-- | Hex string data type.
module Data.ByteArray.HexString.Internal

-- | Represents a Hex string. Guarantees that all characters it contains
--   are valid hex characters.
newtype HexString
HexString :: ByteString -> HexString
[unHexString] :: HexString -> ByteString

-- | Smart constructor which trims '0x' and validates length is even.
hexString :: ByteArray ba => ba -> Either String HexString
instance Codec.Scale.Class.Decode Data.ByteArray.HexString.Internal.HexString
instance Codec.Scale.Class.Encode Data.ByteArray.HexString.Internal.HexString
instance Data.ByteArray.Types.ByteArray Data.ByteArray.HexString.Internal.HexString
instance Data.ByteArray.Types.ByteArrayAccess Data.ByteArray.HexString.Internal.HexString
instance GHC.Base.Monoid Data.ByteArray.HexString.Internal.HexString
instance GHC.Base.Semigroup Data.ByteArray.HexString.Internal.HexString
instance GHC.Classes.Ord Data.ByteArray.HexString.Internal.HexString
instance GHC.Classes.Eq Data.ByteArray.HexString.Internal.HexString
instance GHC.Show.Show Data.ByteArray.HexString.Internal.HexString
instance Data.String.IsString Data.ByteArray.HexString.Internal.HexString


-- | From/to hex conversion functions.
module Data.ByteArray.HexString.Convert

-- | Convert type into it's hex representation.
class ToHex a
toHex :: ToHex a => a -> HexString

-- | Convert hex string into a type or return an error.
class FromHex a
fromHex :: FromHex a => HexString -> Either String a

-- | Reads a raw bytes and converts to hex representation.
fromBytes :: ByteArrayAccess ba => ba -> HexString

-- | Access to the raw bytes of <a>HexString</a>.
toBytes :: ByteArray ba => HexString -> ba

-- | Access to a <a>Text</a> representation of the <a>HexString</a>
toText :: HexString -> Text
instance Data.Aeson.Types.FromJSON.FromJSON Data.ByteArray.HexString.Internal.HexString
instance Data.Aeson.Types.ToJSON.ToJSON Data.ByteArray.HexString.Internal.HexString


-- | Hex string data type top level module.
module Data.ByteArray.HexString


-- | Hex string template haskell helpers.
module Data.ByteArray.HexString.TH
hexFrom :: QuasiQuoter
hex :: QuasiQuoter