Fix headers + add trustworthy/safe (#27)

* fix headers + add trustworthy/safe

* better docs

* better docs

src/Data/ByteString/Base64.hs

@@ -1,17 +1,18 @@
-{-# LANGUAGE BangPatterns #-}
 {-# LANGUAGE OverloadedStrings #-}
+{-# LANGUAGE Trustworthy #-}
 -- |
 -- Module       : Data.ByteString.Base64
 -- Copyright    : (c) 2019-2020 Emily Pillmore
 -- License      : BSD-style
 --
 -- Maintainer   : Emily Pillmore <[email protected]>
--- Stability    : Experimental
+-- Stability    : stable
 -- Portability  : non-portable
 --
--- This module contains the combinators implementing the
--- RFC 4648 specification for the Base64 encoding including
--- unpadded and lenient variants
+-- This module contains 'Data.ByteString.ByteString'-valued combinators for
+-- implementing the RFC 4648 specification of the Base64
+-- encoding format. This includes lenient decoding variants, as well as
+-- internal and external validation for canonicity.
 --
 module Data.ByteString.Base64
 ( encodeBase64

src/Data/ByteString/Base64/URL.hs

@@ -1,17 +1,18 @@
-{-# LANGUAGE BangPatterns #-}
 {-# LANGUAGE OverloadedStrings #-}
+{-# LANGUAGE Trustworthy #-}
 -- |
 -- Module       : Data.ByteString.Base64.URL
 -- Copyright    : (c) 2019-2020 Emily Pillmore
 -- License      : BSD-style
 --
 -- Maintainer   : Emily Pillmore <[email protected]>
--- Stability    : Experimental
+-- Stability    : stable
 -- Portability  : non-portable
 --
--- This module contains the combinators implementing the
--- RFC 4648 specification for the Base64url encoding including
--- unpadded and lenient variants
+-- This module contains 'Data.ByteString.ByteString'-valued combinators for
+-- implementing the RFC 4648 specification of the Base64url
+-- encoding format. This includes strictly padded/unpadded and lenient decoding
+-- variants, as well as internal and external validation for canonicity.
 --
 module Data.ByteString.Base64.URL
 ( encodeBase64

src/Data/ByteString/Lazy/Base64.hs

@@ -1,17 +1,18 @@
-{-# LANGUAGE BangPatterns #-}
 {-# LANGUAGE OverloadedStrings #-}
+{-# LANGUAGE Trustworthy #-}
 -- |
 -- Module       : Data.ByteString.Lazy.Base64
 -- Copyright    : (c) 2019-2020 Emily Pillmore
 -- License      : BSD-style
 --
 -- Maintainer   : Emily Pillmore <[email protected]>
--- Stability    : Experimental
+-- Stability    : stable
 -- Portability  : non-portable
 --
--- This module contains the combinators implementing the
--- RFC 4648 specification for the Base64 encoding including
--- unpadded and lenient variants
+-- This module contains 'Data.ByteString.Lazy.ByteString'-valued combinators for
+-- implementing the RFC 4648 specification of the Base64
+-- encoding format. This includes lenient decoding variants, as well as
+-- internal and external validation for canonicity.
 --
 module Data.ByteString.Lazy.Base64
 ( encodeBase64

src/Data/ByteString/Lazy/Base64/URL.hs

@@ -1,17 +1,19 @@
 {-# LANGUAGE BangPatterns #-}
 {-# LANGUAGE OverloadedStrings #-}
+{-# LANGUAGE Trustworthy #-}
 -- |
 -- Module       : Data.ByteString.Lazy.Base64.URL
 -- Copyright    : (c) 2019-2020 Emily Pillmore
 -- License      : BSD-style
 --
 -- Maintainer   : Emily Pillmore <[email protected]>
--- Stability    : Experimental
+-- Stability    : stable
 -- Portability  : non-portable
 --
--- This module contains the combinators implementing the
--- RFC 4648 specification for the Base64url encoding including
--- unpadded and lenient variants
+-- This module contains 'Data.ByteString.Lazy.ByteString'-valued combinators for
+-- implementing the RFC 4648 specification of the Base64url
+-- encoding format. This includes strictly padded/unpadded and lenient
+-- decoding variants, as well as internal and external validation for canonicity.
 --
 module Data.ByteString.Lazy.Base64.URL
 ( encodeBase64

src/Data/ByteString/Short/Base64.hs

@@ -1,15 +1,17 @@
+{-# LANGUAGE Trustworthy #-}
 -- |
 -- Module       : Data.ByteString.Short.Base64
 -- Copyright    : (c) 2019-2020 Emily Pillmore
 -- License      : BSD-style
 --
 -- Maintainer   : Emily Pillmore <[email protected]>
--- Stability    : Experimental
+-- Stability    : stable
 -- Portability  : non-portable
 --
--- This module contains the combinators implementing the
--- RFC 4648 specification for the Base64 encoding including
--- unpadded and lenient variants
+-- This module contains 'Data.ByteString.Short.ShortByteString'-valued combinators for
+-- implementing the RFC 4648 specification of the Base64
+-- encoding format. This includes lenient decoding variants, as well as
+-- internal and external validation for canonicity.
 --
 module Data.ByteString.Short.Base64
 ( encodeBase64
@@ -27,7 +29,7 @@ import Data.Text (Text)
 import Data.Text.Short (ShortText)
 import Data.Text.Short.Unsafe (fromShortByteStringUnsafe)
 
--- | Encode a 'ShortByteString' value as Base64 'Text' with padding.
+-- | Encode a 'ShortByteString' value as Base64 'ShortText' with padding.
 --
 -- See: <https://tools.ietf.org/html/rfc4648#section-4 RFC-4648 section 4>
 --

src/Data/ByteString/Short/Base64/URL.hs

@@ -1,15 +1,17 @@
+{-# LANGUAGE Trustworthy #-}
 -- |
 -- Module       : Data.ByteString.Short.Base64.URL
 -- Copyright    : (c) 2019-2020 Emily Pillmore
 -- License      : BSD-style
 --
 -- Maintainer   : Emily Pillmore <[email protected]>
--- Stability    : Experimental
+-- Stability    : stable
 -- Portability  : non-portable
 --
--- This module contains the combinators implementing the
--- RFC 4648 specification for the Base64url encoding including
--- unpadded and lenient variants
+-- This module contains 'Data.ByteString.Short.ShortByteString'-valued combinators for
+-- implementing the RFC 4648 specification of the Base64url
+-- encoding format. This includes strictly padded/unpadded and lenient decoding
+-- variants, as well as internal and external validation for canonicity.
 --
 module Data.ByteString.Short.Base64.URL
 ( encodeBase64

src/Data/Text/Encoding/Base64.hs

@@ -1,16 +1,17 @@
-{-# LANGUAGE OverloadedStrings #-}
+{-# LANGUAGE Safe #-}
 -- |
 -- Module       : Data.Text.Encoding.Base64
--- Copyright 	: (c) 2019-2020 Emily Pillmore
--- License	: BSD-style
+-- Copyright    : (c) 2019-2020 Emily Pillmore
+-- License      : BSD-style
 --
--- Maintainer	: Emily Pillmore <[email protected]>
--- Stability	: Experimental
--- Portability	: non-portable
+-- Maintainer   : Emily Pillmore <[email protected]>
+-- Stability    : stable
+-- Portability  : non-portable
 --
--- This module contains the combinators implementing the
--- RFC 4648 specification for the Base64 encoding including
--- unpadded and lenient variants
+-- This module contains 'Data.Text.Text'-valued combinators for
+-- implementing the RFC 4648 specification of the Base64
+-- encoding format. This includes lenient decoding variants, as well as
+-- internal and external validation for canonicity.
 --
 module Data.Text.Encoding.Base64
 ( encodeBase64

src/Data/Text/Encoding/Base64/Error.hs

@@ -1,11 +1,12 @@
+{-# LANGUAGE Safe #-}
 -- |
 -- Module       : Data.Text.Encoding.Base64.Error
--- Copyright 	: (c) 2019-2020 Emily Pillmore
--- License	: BSD-style
+-- Copyright    : (c) 2019-2020 Emily Pillmore
+-- License      : BSD-style
 --
--- Maintainer	: Emily Pillmore <[email protected]>
--- Stability	: Experimental
--- Portability	: non-portable
+-- Maintainer   : Emily Pillmore <[email protected]>
+-- Stability    : stable
+-- Portability  : non-portable
 --
 -- This module contains the error types raised (not as exceptions!)
 -- in the decoding process.

src/Data/Text/Encoding/Base64/URL.hs

@@ -1,16 +1,17 @@
-{-# LANGUAGE OverloadedStrings #-}
+{-# LANGUAGE Safe #-}
 -- |
 -- Module       : Data.Text.Encoding.Base64.URL
--- Copyright 	: (c) 2019-2020 Emily Pillmore
--- License	: BSD-style
+-- Copyright    : (c) 2019-2020 Emily Pillmore
+-- License      : BSD-style
 --
--- Maintainer	: Emily Pillmore <[email protected]>
--- Stability	: Experimental
--- Portability	: non-portable
+-- Maintainer   : Emily Pillmore <[email protected]>
+-- Stability    : stable
+-- Portability  : non-portable
 --
--- This module contains the combinators implementing the
--- RFC 4648 specification for the Base64url encoding including
--- unpadded and lenient variants
+-- This module contains 'Data.Text.Text'-valued combinators for
+-- implementing the RFC 4648 specification of the Base64url
+-- encoding format. This includes strictly padded/unpadded and lenient decoding
+-- variants, as well as internal and external validation for canonicity.
 --
 module Data.Text.Encoding.Base64.URL
 ( encodeBase64

src/Data/Text/Lazy/Encoding/Base64.hs

@@ -1,15 +1,17 @@
+{-# LANGUAGE Safe #-}
 -- |
 -- Module       : Data.Text.Lazy.Encoding.Base64
--- Copyright 	: (c) 2019-2020 Emily Pillmore
--- License	: BSD-style
+-- Copyright    : (c) 2019-2020 Emily Pillmore
+-- License      : BSD-style
 --
--- Maintainer	: Emily Pillmore <[email protected]>
--- Stability	: Experimental
--- Portability	: non-portable
+-- Maintainer   : Emily Pillmore <[email protected]>
+-- Stability    : stable
+-- Portability  : non-portable
 --
--- This module contains the combinators implementing the
--- RFC 4648 specification for the Base64 encoding including
--- unpadded and lenient variants
+-- This module contains 'Data.Text.Lazy.Text'-valued combinators
+-- implementing the RFC 4648 specification for the Base64
+-- encoding format. This includes lenient decoding variants, and
+-- external + internal validations for canonicity.
 --
 module Data.Text.Lazy.Encoding.Base64
 ( encodeBase64

src/Data/Text/Lazy/Encoding/Base64/URL.hs

@@ -1,15 +1,17 @@
+{-# LANGUAGE Safe #-}
 -- |
 -- Module       : Data.Text.Lazy.Encoding.Base64.URL
--- Copyright 	: (c) 2019-2020 Emily Pillmore
--- License	: BSD-style
+-- Copyright    : (c) 2019-2020 Emily Pillmore
+-- License      : BSD-style
 --
--- Maintainer	: Emily Pillmore <[email protected]>
--- Stability	: Experimental
--- Portability	: non-portable
+-- Maintainer   : Emily Pillmore <[email protected]>
+-- Stability    : stable
+-- Portability  : non-portable
 --
--- This module contains the combinators implementing the
--- RFC 4648 specification for the Base64url encoding including
--- unpadded and lenient variants
+-- This module contains 'Data.Text.Lazy.Text'-valued combinators for
+-- implementing the RFC 4648 specification of the Base64url
+-- encoding format. This includes strictly padded/unpadded and lenient decoding
+-- variants, as well as internal and external validation for canonicity.
 --
 module Data.Text.Lazy.Encoding.Base64.URL
 ( encodeBase64

src/Data/Text/Short/Encoding/Base64.hs

@@ -1,16 +1,17 @@
-{-# LANGUAGE OverloadedStrings #-}
+{-# LANGUAGE Trustworthy #-}
 -- |
--- Module       : Data.Text.Encoding.Base64
--- Copyright 	: (c) 2019-2020 Emily Pillmore
--- License	: BSD-style
---
--- Maintainer	: Emily Pillmore <[email protected]>
--- Stability	: Experimental
--- Portability	: non-portable
---
--- This module contains the combinators implementing the
--- RFC 4648 specification for the Base64 encoding including
--- unpadded and lenient variants
+-- Module       : Data.Text.Short.Encoding.Base64
+-- Copyright    : (c) 2019-2020 Emily Pillmore
+-- License      : BSD-style
+--
+-- Maintainer   : Emily Pillmore <[email protected]>
+-- Stability    : stable
+-- Portability  : non-portable
+--
+-- This module contains 'Data.Text.Short.ShortText'-valued combinators
+-- implementing the RFC 4648 specification for the Base64
+-- encoding format. This includes lenient decoding variants, and
+-- external + internal validations for canonicity.
 --
 module Data.Text.Short.Encoding.Base64
 ( encodeBase64

src/Data/Text/Short/Encoding/Base64/URL.hs

@@ -1,15 +1,17 @@
+{-# LANGUAGE Trustworthy #-}
 -- |
 -- Module       : Data.Text.Short.Encoding.Base64.URL
--- Copyright 	: (c) 2019-2020 Emily Pillmore
--- License	: BSD-style
+-- Copyright    : (c) 2019-2020 Emily Pillmore
+-- License      : BSD-style
 --
--- Maintainer	: Emily Pillmore <[email protected]>
--- Stability	: Experimental
--- Portability	: non-portable
+-- Maintainer   : Emily Pillmore <[email protected]>
+-- Stability    : stable
+-- Portability  : non-portable
 --
--- This module contains the combinators implementing the
--- RFC 4648 specification for the Base64url encoding including
--- unpadded and lenient variants
+-- This module contains 'Data.Text.Short.ShortText'-valued combinators
+-- implementing the RFC 4648 specification for the Base64url
+-- encoding format. This includes strictly padded/unpadded and lenient
+-- decoding variants, and external + internal validations for canonicity.
 --
 module Data.Text.Short.Encoding.Base64.URL
 ( encodeBase64