Raaz.Core.Encode

The encodable type

Many types like cryptographic hashes, secret keys etc can be encoded into bytes. This module gives an interface to such objects using the Encodable type class. To ease their printing most types of this class have a Show instances. Similarly, to make it easy to defines constants of these types in source code, they often are instances of IsString. Typically for cryptographic types like hashes, secret keys etc the Show and IsString instances correspond to the base-16 encoding of these types.

class Encodable a where

The type class Encodable captures all the types can be encoding into ByteString.

Methods

toByteString :: a -> ByteString

Convert stuff to bytestring

fromByteString :: ByteString -> Maybe a

Try parsing back a value. Returns nothing on failure.

unsafeFromByteString :: ByteString -> a

Unsafe version of fromByteString

toByteString :: EndianStore a => a -> ByteString

Convert stuff to bytestring

fromByteString :: EndianStore a => ByteString -> Maybe a

Try parsing back a value. Returns nothing on failure.

Instances

Encodable ByteString

Methods

toByteString :: ByteString -> ByteString

fromByteString :: ByteString -> Maybe ByteString

unsafeFromByteString :: ByteString -> ByteString

Encodable Base16

Methods

toByteString :: Base16 -> ByteString

fromByteString :: ByteString -> Maybe Base16

unsafeFromByteString :: ByteString -> Base16

Encodable Write

Methods

toByteString :: Write -> ByteString

fromByteString :: ByteString -> Maybe Write

unsafeFromByteString :: ByteString -> Write

Encodable SHA1

Methods

toByteString :: SHA1 -> ByteString

fromByteString :: ByteString -> Maybe SHA1

unsafeFromByteString :: ByteString -> SHA1

Encodable SHA224

Methods

toByteString :: SHA224 -> ByteString

fromByteString :: ByteString -> Maybe SHA224

unsafeFromByteString :: ByteString -> SHA224

Encodable SHA256

Methods

toByteString :: SHA256 -> ByteString

fromByteString :: ByteString -> Maybe SHA256

unsafeFromByteString :: ByteString -> SHA256

Encodable SHA384

Methods

toByteString :: SHA384 -> ByteString

fromByteString :: ByteString -> Maybe SHA384

unsafeFromByteString :: ByteString -> SHA384

Encodable SHA512

Methods

toByteString :: SHA512 -> ByteString

fromByteString :: ByteString -> Maybe SHA512

unsafeFromByteString :: ByteString -> SHA512

Encodable IV

Methods

toByteString :: IV -> ByteString

fromByteString :: ByteString -> Maybe IV

unsafeFromByteString :: ByteString -> IV

Encodable KEY256

Methods

toByteString :: KEY256 -> ByteString

fromByteString :: ByteString -> Maybe KEY256

unsafeFromByteString :: ByteString -> KEY256

Encodable KEY192

Methods

toByteString :: KEY192 -> ByteString

fromByteString :: ByteString -> Maybe KEY192

unsafeFromByteString :: ByteString -> KEY192

Encodable KEY128

Methods

toByteString :: KEY128 -> ByteString

fromByteString :: ByteString -> Maybe KEY128

unsafeFromByteString :: ByteString -> KEY128

Encodable a => Encodable (BITS a)

Methods

toByteString :: BITS a -> ByteString

fromByteString :: ByteString -> Maybe (BITS a)

unsafeFromByteString :: ByteString -> BITS a

Encodable a => Encodable (BYTES a)

Methods

toByteString :: BYTES a -> ByteString

fromByteString :: ByteString -> Maybe (BYTES a)

unsafeFromByteString :: ByteString -> BYTES a

Encodable (BE Word32)

Methods

toByteString :: BE Word32 -> ByteString

fromByteString :: ByteString -> Maybe (BE Word32)

unsafeFromByteString :: ByteString -> BE Word32

Encodable (BE Word64)

Methods

toByteString :: BE Word64 -> ByteString

fromByteString :: ByteString -> Maybe (BE Word64)

unsafeFromByteString :: ByteString -> BE Word64

Encodable (LE Word32)

Methods

toByteString :: LE Word32 -> ByteString

fromByteString :: ByteString -> Maybe (LE Word32)

unsafeFromByteString :: ByteString -> LE Word32

Encodable (LE Word64)

Methods

toByteString :: LE Word64 -> ByteString

fromByteString :: ByteString -> Maybe (LE Word64)

unsafeFromByteString :: ByteString -> LE Word64

Encodable h => Encodable (HMAC h)

Methods

toByteString :: HMAC h -> ByteString

fromByteString :: ByteString -> Maybe (HMAC h)

unsafeFromByteString :: ByteString -> HMAC h

Encoding formats

We also give facilities to encode any instance of Encodable into multiple formats. For type safety, encoding formats are distinguished by their types. All such formats have to be members of the Format type class and this allows encoding and decoding any type that is an instance of Encodable into any of the desired format.

class (IsString fmt, Show fmt, Encodable fmt) => Format fmt where

A binary encoding format is something for which there is a 1:1 correspondence with bytestrings. We also insist that it is an instance of IsString, so that it can be easily included in source code, and Show, so that it can be easily printed out.

Minimal complete definition

encodeByteString, decodeFormat

Methods

encodeByteString :: ByteString -> fmt

decodeFormat :: fmt -> ByteString

Instances

Format ByteString

Bytestring itself is an encoding format (namely binary format).

Methods

encodeByteString :: ByteString -> ByteString

decodeFormat :: ByteString -> ByteString

Format Base16

Methods

encodeByteString :: ByteString -> Base16

decodeFormat :: Base16 -> ByteString

encode :: (Encodable a, Format fmt) => a -> fmt

Encode in a given format.

decode :: (Format fmt, Encodable a) => fmt -> Maybe a

Decode from a given format. It results in Nothing if there is a parse error.

unsafeDecode :: (Format fmt, Encodable a) => fmt -> a

The unsafe version of decode.

The base 16 encoding fromat

data Base16

The base16 type.

Instances

Eq Base16

Methods

(==) :: Base16 -> Base16 -> Bool

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

Show Base16

Methods

showsPrec :: Int -> Base16 -> ShowS

show :: Base16 -> String

showList :: [Base16] -> ShowS

IsString Base16

Methods

fromString :: String -> Base16

Monoid Base16

Methods

mempty :: Base16

mappend :: Base16 -> Base16 -> Base16

mconcat :: [Base16] -> Base16

Format Base16

Methods

encodeByteString :: ByteString -> Base16

decodeFormat :: Base16 -> ByteString

Encodable Base16

Methods

toByteString :: Base16 -> ByteString

fromByteString :: ByteString -> Maybe Base16

unsafeFromByteString :: ByteString -> Base16

fromBase16 :: Encodable a => String -> a

Base16 variant of fromString. Useful in definition of IsString instances as well as in cases where the default IsString instance does not parse from a base16 encoding.

showBase16 :: Encodable a => a -> String

Base16 variant of show.