crypton-asn1-encoding-0.9.7: src/Data/ASN1/Encoding.hs

{- |
Module      : Data.ASN1.Encoding
License     : BSD-style
Copyright   : (c) 2010-2013 Vincent Hanquez <vincent@snarc.org>
Stability   : experimental
Portability : unknown
-}

module Data.ASN1.Encoding
  ( -- * Generic class for decoding and encoding a stream
    ASN1Decoding (..)
  , ASN1DecodingRepr (..)
  , ASN1Encoding (..)
    -- * Strict bytestring alternatives
  , decodeASN1'
  , decodeASN1Repr'
  , encodeASN1'
  ) where

import           Data.ASN1.Error ( ASN1Error )
import           Data.ASN1.Stream ( ASN1Repr )
import           Data.ASN1.Types ( ASN1 )
import qualified Data.ByteString as B
import qualified Data.ByteString.Lazy as L

-- | Describe an ASN.1 decoding, that transforms a lazy bytestring into a list
-- of ASN.1 values.
class ASN1Decoding a where
  -- | Decode a lazy bytestring into a list of ASN.1 values.
  decodeASN1 :: a -> L.ByteString -> Either ASN1Error [ASN1]

-- | Transition class.
class ASN1DecodingRepr a where
  -- | Decode a lazy bytestring into a list of 'ASN1Repr' pairs.
  decodeASN1Repr :: a -> L.ByteString -> Either ASN1Error [ASN1Repr]

-- | Describe an ASN.1 encoding, that transforms a list of ASN.1 values into a
-- lazy bytestring.
class ASN1Encoding a where
  -- | Encode a list of ASN.1 values into a lazy bytestring.
  encodeASN1 :: a -> [ASN1] -> L.ByteString

-- | Decode a strict bytestring into a list of ASN.1 values.
decodeASN1' :: ASN1Decoding a => a -> B.ByteString -> Either ASN1Error [ASN1]
decodeASN1' encoding bs = decodeASN1 encoding $ L.fromChunks [bs]

-- | Decode a strict bytestring into a list of 'ASN1Repr' pairs.
decodeASN1Repr' ::
     ASN1DecodingRepr a
  => a
  -> B.ByteString
  -> Either ASN1Error [ASN1Repr]
decodeASN1Repr' encoding bs = decodeASN1Repr encoding $ L.fromChunks [bs]

-- | Encode a list of ASN.1 values into a strict bytestring.
encodeASN1' :: ASN1Encoding a => a -> [ASN1] -> B.ByteString
encodeASN1' encoding = B.concat . L.toChunks . encodeASN1 encoding