Copyright	(c) Daniel Mendler 2017
License	MIT
Maintainer	mail@daniel-mendler.de
Stability	experimental
Portability	portable
Safe Haskell	Safe
Language	Haskell2010

Data.String.Encode

Description

String conversion and decoding

Synopsis

Documentation

class ConvertString a b where Source #

Conversion of strings to other string types

(convertString :: b -> a)         . (convertString :: a -> b) ≡ (id      :: a -> a)
(convertString :: b -> Maybe a)   . (convertString :: a -> b) ≡ (Just    :: a -> Maybe a)
(convertString :: b -> Lenient a) . (convertString :: a -> b) ≡ (Lenient :: a -> Lenient a)

Minimal complete definition

convertString

Methods

convertString :: a -> b Source #

Convert a string to another string type

Instances

ConvertString String String Source #
Methods convertString :: String -> String Source #
ConvertString String ShortByteString Source #
Methods convertString :: String -> ShortByteString Source #
ConvertString String ByteString Source #
Methods convertString :: String -> ByteString Source #
ConvertString String ByteString Source #
Methods convertString :: String -> ByteString Source #
ConvertString String Text Source #
Methods convertString :: String -> Text Source #
ConvertString String Text Source #
Methods convertString :: String -> Text Source #
ConvertString ShortByteString ShortByteString Source #
Methods convertString :: ShortByteString -> ShortByteString Source #
ConvertString ShortByteString ByteString Source #
Methods convertString :: ShortByteString -> ByteString Source #
ConvertString ShortByteString ByteString Source #
Methods convertString :: ShortByteString -> ByteString Source #
ConvertString ByteString ShortByteString Source #
Methods convertString :: ByteString -> ShortByteString Source #
ConvertString ByteString ByteString Source #
Methods convertString :: ByteString -> ByteString Source #
ConvertString ByteString ByteString Source #
Methods convertString :: ByteString -> ByteString Source #
ConvertString ByteString ShortByteString Source #
Methods convertString :: ByteString -> ShortByteString Source #
ConvertString ByteString ByteString Source #
Methods convertString :: ByteString -> ByteString Source #
ConvertString ByteString ByteString Source #
Methods convertString :: ByteString -> ByteString Source #
ConvertString Text String Source #
Methods convertString :: Text -> String Source #
ConvertString Text ShortByteString Source #
Methods convertString :: Text -> ShortByteString Source #
ConvertString Text ByteString Source #
Methods convertString :: Text -> ByteString Source #
ConvertString Text ByteString Source #
Methods convertString :: Text -> ByteString Source #
ConvertString Text Text Source #
Methods convertString :: Text -> Text Source #
ConvertString Text Text Source #
Methods convertString :: Text -> Text Source #
ConvertString Text String Source #
Methods convertString :: Text -> String Source #
ConvertString Text ShortByteString Source #
Methods convertString :: Text -> ShortByteString Source #
ConvertString Text ByteString Source #
Methods convertString :: Text -> ByteString Source #
ConvertString Text ByteString Source #
Methods convertString :: Text -> ByteString Source #
ConvertString Text Text Source #
Methods convertString :: Text -> Text Source #
ConvertString Text Text Source #
Methods convertString :: Text -> Text Source #
ConvertString String [Word8] Source #
Methods convertString :: String -> [Word8] Source #
ConvertString ShortByteString [Word8] Source #
Methods convertString :: ShortByteString -> [Word8] Source #
ConvertString ShortByteString (Maybe String) Source #
Methods convertString :: ShortByteString -> Maybe String Source #
ConvertString ShortByteString (Maybe Text) Source #
Methods convertString :: ShortByteString -> Maybe Text Source #
ConvertString ShortByteString (Maybe Text) Source #
Methods convertString :: ShortByteString -> Maybe Text Source #
ConvertString ShortByteString (Lenient String) Source #
Methods convertString :: ShortByteString -> Lenient String Source #
ConvertString ShortByteString (Lenient Text) Source #
Methods convertString :: ShortByteString -> Lenient Text Source #
ConvertString ShortByteString (Lenient Text) Source #
Methods convertString :: ShortByteString -> Lenient Text Source #
ConvertString ByteString [Word8] Source #
Methods convertString :: ByteString -> [Word8] Source #
ConvertString ByteString (Maybe String) Source #
Methods convertString :: ByteString -> Maybe String Source #
ConvertString ByteString (Maybe Text) Source #
Methods convertString :: ByteString -> Maybe Text Source #
ConvertString ByteString (Maybe Text) Source #
Methods convertString :: ByteString -> Maybe Text Source #
ConvertString ByteString (Lenient String) Source #
Methods convertString :: ByteString -> Lenient String Source #
ConvertString ByteString (Lenient Text) Source #
Methods convertString :: ByteString -> Lenient Text Source #
ConvertString ByteString (Lenient Text) Source #
Methods convertString :: ByteString -> Lenient Text Source #
ConvertString ByteString [Word8] Source #
Methods convertString :: ByteString -> [Word8] Source #
ConvertString ByteString (Maybe String) Source #
Methods convertString :: ByteString -> Maybe String Source #
ConvertString ByteString (Maybe Text) Source #
Methods convertString :: ByteString -> Maybe Text Source #
ConvertString ByteString (Maybe Text) Source #
Methods convertString :: ByteString -> Maybe Text Source #
ConvertString ByteString (Lenient String) Source #
Methods convertString :: ByteString -> Lenient String Source #
ConvertString ByteString (Lenient Text) Source #
Methods convertString :: ByteString -> Lenient Text Source #
ConvertString ByteString (Lenient Text) Source #
Methods convertString :: ByteString -> Lenient Text Source #
ConvertString Text [Word8] Source #
Methods convertString :: Text -> [Word8] Source #
ConvertString Text [Word8] Source #
Methods convertString :: Text -> [Word8] Source #
ConvertString [Word8] ShortByteString Source #
Methods convertString :: [Word8] -> ShortByteString Source #
ConvertString [Word8] ByteString Source #
Methods convertString :: [Word8] -> ByteString Source #
ConvertString [Word8] ByteString Source #
Methods convertString :: [Word8] -> ByteString Source #
ConvertString [Word8] [Word8] Source #
Methods convertString :: [Word8] -> [Word8] Source #
ConvertString [Word8] (Maybe String) Source #
Methods convertString :: [Word8] -> Maybe String Source #
ConvertString [Word8] (Maybe Text) Source #
Methods convertString :: [Word8] -> Maybe Text Source #
ConvertString [Word8] (Maybe Text) Source #
Methods convertString :: [Word8] -> Maybe Text Source #
ConvertString [Word8] (Lenient String) Source #
Methods convertString :: [Word8] -> Lenient String Source #
ConvertString [Word8] (Lenient Text) Source #
Methods convertString :: [Word8] -> Lenient Text Source #
ConvertString [Word8] (Lenient Text) Source #
Methods convertString :: [Word8] -> Lenient Text Source #

class (ConvertString a b, ConvertString b (Maybe a), ConvertString b (Lenient a)) => EncodeString a b where Source #

Encode and decode strings as a byte sequence

decodeString        . encodeString ≡ Just
decodeStringLenient . encodeString ≡ id

Methods

encodeString :: a -> b Source #

Encode a string as a byte sequence

decodeStringLenient :: b -> a Source #

Lenient decoding of byte sequence

Lenient means that invalid characters are replaced by the Unicode replacement character '\FFFD'.

decodeString :: b -> Maybe a Source #

Decode byte sequence

If the decoding fails, return Nothing.

Instances

EncodeString String ShortByteString Source #
Methods encodeString :: String -> ShortByteString Source # decodeStringLenient :: ShortByteString -> String Source # decodeString :: ShortByteString -> Maybe String Source #
EncodeString String ByteString Source #
Methods encodeString :: String -> ByteString Source # decodeStringLenient :: ByteString -> String Source # decodeString :: ByteString -> Maybe String Source #
EncodeString String ByteString Source #
Methods encodeString :: String -> ByteString Source # decodeStringLenient :: ByteString -> String Source # decodeString :: ByteString -> Maybe String Source #
EncodeString Text ShortByteString Source #
Methods encodeString :: Text -> ShortByteString Source # decodeStringLenient :: ShortByteString -> Text Source # decodeString :: ShortByteString -> Maybe Text Source #
EncodeString Text ByteString Source #
Methods encodeString :: Text -> ByteString Source # decodeStringLenient :: ByteString -> Text Source # decodeString :: ByteString -> Maybe Text Source #
EncodeString Text ByteString Source #
Methods encodeString :: Text -> ByteString Source # decodeStringLenient :: ByteString -> Text Source # decodeString :: ByteString -> Maybe Text Source #
EncodeString Text ShortByteString Source #
Methods encodeString :: Text -> ShortByteString Source # decodeStringLenient :: ShortByteString -> Text Source # decodeString :: ShortByteString -> Maybe Text Source #
EncodeString Text ByteString Source #
Methods encodeString :: Text -> ByteString Source # decodeStringLenient :: ByteString -> Text Source # decodeString :: ByteString -> Maybe Text Source #
EncodeString Text ByteString Source #
Methods encodeString :: Text -> ByteString Source # decodeStringLenient :: ByteString -> Text Source # decodeString :: ByteString -> Maybe Text Source #
EncodeString String [Word8] Source #
Methods encodeString :: String -> [Word8] Source # decodeStringLenient :: [Word8] -> String Source # decodeString :: [Word8] -> Maybe String Source #
EncodeString Text [Word8] Source #
Methods encodeString :: Text -> [Word8] Source # decodeStringLenient :: [Word8] -> Text Source # decodeString :: [Word8] -> Maybe Text Source #
EncodeString Text [Word8] Source #
Methods encodeString :: Text -> [Word8] Source # decodeStringLenient :: [Word8] -> Text Source # decodeString :: [Word8] -> Maybe Text Source #

newtype Lenient a Source #

Newtype wrapper for a string which was decoded leniently.

Constructors

Lenient
Fields getLenient :: a

Instances

Functor Lenient Source #
Methods fmap :: (a -> b) -> Lenient a -> Lenient b # (<$) :: a -> Lenient b -> Lenient a #
Foldable Lenient Source #
Methods fold :: Monoid m => Lenient m -> m # foldMap :: Monoid m => (a -> m) -> Lenient a -> m # foldr :: (a -> b -> b) -> b -> Lenient a -> b # foldr' :: (a -> b -> b) -> b -> Lenient a -> b # foldl :: (b -> a -> b) -> b -> Lenient a -> b # foldl' :: (b -> a -> b) -> b -> Lenient a -> b # foldr1 :: (a -> a -> a) -> Lenient a -> a # foldl1 :: (a -> a -> a) -> Lenient a -> a # toList :: Lenient a -> [a] # null :: Lenient a -> Bool # length :: Lenient a -> Int # elem :: Eq a => a -> Lenient a -> Bool # maximum :: Ord a => Lenient a -> a # minimum :: Ord a => Lenient a -> a # sum :: Num a => Lenient a -> a # product :: Num a => Lenient a -> a #
Traversable Lenient Source #
Methods traverse :: Applicative f => (a -> f b) -> Lenient a -> f (Lenient b) # sequenceA :: Applicative f => Lenient (f a) -> f (Lenient a) # mapM :: Monad m => (a -> m b) -> Lenient a -> m (Lenient b) # sequence :: Monad m => Lenient (m a) -> m (Lenient a) #
Generic1 Lenient Source #
Associated Types type Rep1 (Lenient :: * -> ) :: -> * # Methods from1 :: Lenient a -> Rep1 Lenient a # to1 :: Rep1 Lenient a -> Lenient a #
ConvertString ShortByteString (Lenient String) Source #
Methods convertString :: ShortByteString -> Lenient String Source #
ConvertString ShortByteString (Lenient Text) Source #
Methods convertString :: ShortByteString -> Lenient Text Source #
ConvertString ShortByteString (Lenient Text) Source #
Methods convertString :: ShortByteString -> Lenient Text Source #
ConvertString ByteString (Lenient String) Source #
Methods convertString :: ByteString -> Lenient String Source #
ConvertString ByteString (Lenient Text) Source #
Methods convertString :: ByteString -> Lenient Text Source #
ConvertString ByteString (Lenient Text) Source #
Methods convertString :: ByteString -> Lenient Text Source #
ConvertString ByteString (Lenient String) Source #
Methods convertString :: ByteString -> Lenient String Source #
ConvertString ByteString (Lenient Text) Source #
Methods convertString :: ByteString -> Lenient Text Source #
ConvertString ByteString (Lenient Text) Source #
Methods convertString :: ByteString -> Lenient Text Source #
Eq a => Eq (Lenient a) Source #
Methods (==) :: Lenient a -> Lenient a -> Bool # (/=) :: Lenient a -> Lenient a -> Bool #
Ord a => Ord (Lenient a) Source #
Methods compare :: Lenient a -> Lenient a -> Ordering # (<) :: Lenient a -> Lenient a -> Bool # (<=) :: Lenient a -> Lenient a -> Bool # (>) :: Lenient a -> Lenient a -> Bool # (>=) :: Lenient a -> Lenient a -> Bool # max :: Lenient a -> Lenient a -> Lenient a # min :: Lenient a -> Lenient a -> Lenient a #
Read a => Read (Lenient a) Source #
Methods readsPrec :: Int -> ReadS (Lenient a) # readList :: ReadS [Lenient a] # readPrec :: ReadPrec (Lenient a) # readListPrec :: ReadPrec [Lenient a] #
Show a => Show (Lenient a) Source #
Methods showsPrec :: Int -> Lenient a -> ShowS # show :: Lenient a -> String # showList :: [Lenient a] -> ShowS #
Generic (Lenient a) Source #
Associated Types type Rep (Lenient a) :: * -> * # Methods from :: Lenient a -> Rep (Lenient a) x # to :: Rep (Lenient a) x -> Lenient a #
ConvertString [Word8] (Lenient String) Source #
Methods convertString :: [Word8] -> Lenient String Source #
ConvertString [Word8] (Lenient Text) Source #
Methods convertString :: [Word8] -> Lenient Text Source #
ConvertString [Word8] (Lenient Text) Source #
Methods convertString :: [Word8] -> Lenient Text Source #
type Rep1 Lenient Source #
type Rep1 Lenient = D1 (MetaData "Lenient" "Data.String.Encode" "encode-string-0.1.0.0-aczNfUUDOHEwNkt2YLL1L" True) (C1 (MetaCons "Lenient" PrefixI True) (S1 (MetaSel (Just Symbol "getLenient") NoSourceUnpackedness NoSourceStrictness DecidedLazy) Par1))
type Rep (Lenient a) Source #
type Rep (Lenient a) = D1 (MetaData "Lenient" "Data.String.Encode" "encode-string-0.1.0.0-aczNfUUDOHEwNkt2YLL1L" True) (C1 (MetaCons "Lenient" PrefixI True) (S1 (MetaSel (Just Symbol "getLenient") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 a)))