Data.String.Encode

String conversion and decoding

Documentation

class ConvertString a b where

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

Convert a string to another string type

Instances

ConvertString String String

Methods

convertString :: String -> String

ConvertString String ShortByteString

Methods

convertString :: String -> ShortByteString

ConvertString String ByteString

Methods

convertString :: String -> ByteString

ConvertString String ByteString

Methods

convertString :: String -> ByteString

ConvertString String Text

Methods

convertString :: String -> Text

ConvertString String Text

Methods

convertString :: String -> Text

ConvertString ShortByteString ShortByteString

Methods

convertString :: ShortByteString -> ShortByteString

ConvertString ShortByteString ByteString

Methods

convertString :: ShortByteString -> ByteString

ConvertString ShortByteString ByteString

Methods

convertString :: ShortByteString -> ByteString

ConvertString ByteString ShortByteString

Methods

convertString :: ByteString -> ShortByteString

ConvertString ByteString ByteString

Methods

convertString :: ByteString -> ByteString

ConvertString ByteString ByteString

Methods

convertString :: ByteString -> ByteString

ConvertString ByteString ShortByteString

Methods

convertString :: ByteString -> ShortByteString

ConvertString ByteString ByteString

Methods

convertString :: ByteString -> ByteString

ConvertString ByteString ByteString

Methods

convertString :: ByteString -> ByteString

ConvertString Text String

Methods

convertString :: Text -> String

ConvertString Text ShortByteString

Methods

convertString :: Text -> ShortByteString

ConvertString Text ByteString

Methods

convertString :: Text -> ByteString

ConvertString Text ByteString

Methods

convertString :: Text -> ByteString

ConvertString Text Text

Methods

convertString :: Text -> Text

ConvertString Text Text

Methods

convertString :: Text -> Text

ConvertString Text String

Methods

convertString :: Text -> String

ConvertString Text ShortByteString

Methods

convertString :: Text -> ShortByteString

ConvertString Text ByteString

Methods

convertString :: Text -> ByteString

ConvertString Text ByteString

Methods

convertString :: Text -> ByteString

ConvertString Text Text

Methods

convertString :: Text -> Text

ConvertString Text Text

Methods

convertString :: Text -> Text

ConvertString String [Word8]

Methods

convertString :: String -> [Word8]

ConvertString ShortByteString [Word8]

Methods

convertString :: ShortByteString -> [Word8]

ConvertString ShortByteString (Maybe String)

Methods

convertString :: ShortByteString -> Maybe String

ConvertString ShortByteString (Maybe Text)

Methods

convertString :: ShortByteString -> Maybe Text

ConvertString ShortByteString (Maybe Text)

Methods

convertString :: ShortByteString -> Maybe Text

ConvertString ShortByteString (Lenient String)

Methods

convertString :: ShortByteString -> Lenient String

ConvertString ShortByteString (Lenient Text)

Methods

convertString :: ShortByteString -> Lenient Text

ConvertString ShortByteString (Lenient Text)

Methods

convertString :: ShortByteString -> Lenient Text

ConvertString ByteString [Word8]

Methods

convertString :: ByteString -> [Word8]

ConvertString ByteString (Maybe String)

Methods

convertString :: ByteString -> Maybe String

ConvertString ByteString (Maybe Text)

Methods

convertString :: ByteString -> Maybe Text

ConvertString ByteString (Maybe Text)

Methods

convertString :: ByteString -> Maybe Text

ConvertString ByteString (Lenient String)

Methods

convertString :: ByteString -> Lenient String

ConvertString ByteString (Lenient Text)

Methods

convertString :: ByteString -> Lenient Text

ConvertString ByteString (Lenient Text)

Methods

convertString :: ByteString -> Lenient Text

ConvertString ByteString [Word8]

Methods

convertString :: ByteString -> [Word8]

ConvertString ByteString (Maybe String)

Methods

convertString :: ByteString -> Maybe String

ConvertString ByteString (Maybe Text)

Methods

convertString :: ByteString -> Maybe Text

ConvertString ByteString (Maybe Text)

Methods

convertString :: ByteString -> Maybe Text

ConvertString ByteString (Lenient String)

Methods

convertString :: ByteString -> Lenient String

ConvertString ByteString (Lenient Text)

Methods

convertString :: ByteString -> Lenient Text

ConvertString ByteString (Lenient Text)

Methods

convertString :: ByteString -> Lenient Text

ConvertString Text [Word8]

Methods

convertString :: Text -> [Word8]

ConvertString Text [Word8]

Methods

convertString :: Text -> [Word8]

ConvertString [Word8] ShortByteString

Methods

convertString :: [Word8] -> ShortByteString

ConvertString [Word8] ByteString

Methods

convertString :: [Word8] -> ByteString

ConvertString [Word8] ByteString

Methods

convertString :: [Word8] -> ByteString

ConvertString [Word8] [Word8]

Methods

convertString :: [Word8] -> [Word8]

ConvertString [Word8] (Maybe String)

Methods

convertString :: [Word8] -> Maybe String

ConvertString [Word8] (Maybe Text)

Methods

convertString :: [Word8] -> Maybe Text

ConvertString [Word8] (Maybe Text)

Methods

convertString :: [Word8] -> Maybe Text

ConvertString [Word8] (Lenient String)

Methods

convertString :: [Word8] -> Lenient String

ConvertString [Word8] (Lenient Text)

Methods

convertString :: [Word8] -> Lenient Text

ConvertString [Word8] (Lenient Text)

Methods

convertString :: [Word8] -> Lenient Text

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

Encode and decode strings as a byte sequence

decodeString        . encodeString ≡ Just
decodeStringLenient . encodeString ≡ id

Methods

encodeString :: a -> b

Encode a string as a byte sequence

decodeStringLenient :: b -> a

Lenient decoding of byte sequence

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

decodeString :: b -> Maybe a

Decode byte sequence

If the decoding fails, return Nothing.

Instances

EncodeString String ShortByteString

Methods

encodeString :: String -> ShortByteString

decodeStringLenient :: ShortByteString -> String

decodeString :: ShortByteString -> Maybe String

EncodeString String ByteString

Methods

encodeString :: String -> ByteString

decodeStringLenient :: ByteString -> String

decodeString :: ByteString -> Maybe String

EncodeString String ByteString

Methods

encodeString :: String -> ByteString

decodeStringLenient :: ByteString -> String

decodeString :: ByteString -> Maybe String

EncodeString Text ShortByteString

Methods

encodeString :: Text -> ShortByteString

decodeStringLenient :: ShortByteString -> Text

decodeString :: ShortByteString -> Maybe Text

EncodeString Text ByteString

Methods

encodeString :: Text -> ByteString

decodeStringLenient :: ByteString -> Text

decodeString :: ByteString -> Maybe Text

EncodeString Text ByteString

Methods

encodeString :: Text -> ByteString

decodeStringLenient :: ByteString -> Text

decodeString :: ByteString -> Maybe Text

EncodeString Text ShortByteString

Methods

encodeString :: Text -> ShortByteString

decodeStringLenient :: ShortByteString -> Text

decodeString :: ShortByteString -> Maybe Text

EncodeString Text ByteString

Methods

encodeString :: Text -> ByteString

decodeStringLenient :: ByteString -> Text

decodeString :: ByteString -> Maybe Text

EncodeString Text ByteString

Methods

encodeString :: Text -> ByteString

decodeStringLenient :: ByteString -> Text

decodeString :: ByteString -> Maybe Text

EncodeString String [Word8]

Methods

encodeString :: String -> [Word8]

decodeStringLenient :: [Word8] -> String

decodeString :: [Word8] -> Maybe String

EncodeString Text [Word8]

Methods

encodeString :: Text -> [Word8]

decodeStringLenient :: [Word8] -> Text

decodeString :: [Word8] -> Maybe Text

EncodeString Text [Word8]

Methods

encodeString :: Text -> [Word8]

decodeStringLenient :: [Word8] -> Text

decodeString :: [Word8] -> Maybe Text

newtype Lenient a

Newtype wrapper for a string which was decoded leniently.

Constructors

Lenient

Fields

• getLenient :: a

Instances

Functor Lenient

Methods

fmap :: (a -> b) -> Lenient a -> Lenient b

(<$) :: a -> Lenient b -> Lenient a

Foldable Lenient

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

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

Associated Types

type Rep1 (Lenient :: * -> *) :: * -> *

Methods

from1 :: Lenient a -> Rep1 Lenient a

to1 :: Rep1 Lenient a -> Lenient a

ConvertString ShortByteString (Lenient String)

Methods

convertString :: ShortByteString -> Lenient String

ConvertString ShortByteString (Lenient Text)

Methods

convertString :: ShortByteString -> Lenient Text

ConvertString ShortByteString (Lenient Text)

Methods

convertString :: ShortByteString -> Lenient Text

ConvertString ByteString (Lenient String)

Methods

convertString :: ByteString -> Lenient String

ConvertString ByteString (Lenient Text)

Methods

convertString :: ByteString -> Lenient Text

ConvertString ByteString (Lenient Text)

Methods

convertString :: ByteString -> Lenient Text

ConvertString ByteString (Lenient String)

Methods

convertString :: ByteString -> Lenient String

ConvertString ByteString (Lenient Text)

Methods

convertString :: ByteString -> Lenient Text

ConvertString ByteString (Lenient Text)

Methods

convertString :: ByteString -> Lenient Text

Eq a => Eq (Lenient a)

Methods

(==) :: Lenient a -> Lenient a -> Bool

(/=) :: Lenient a -> Lenient a -> Bool

Ord a => Ord (Lenient a)

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)

Methods

readsPrec :: Int -> ReadS (Lenient a)

readList :: ReadS [Lenient a]

readPrec :: ReadPrec (Lenient a)

readListPrec :: ReadPrec [Lenient a]

Show a => Show (Lenient a)

Methods

showsPrec :: Int -> Lenient a -> ShowS

show :: Lenient a -> String

showList :: [Lenient a] -> ShowS

Generic (Lenient a)

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)

Methods

convertString :: [Word8] -> Lenient String

ConvertString [Word8] (Lenient Text)

Methods

convertString :: [Word8] -> Lenient Text

ConvertString [Word8] (Lenient Text)

Methods

convertString :: [Word8] -> Lenient Text

type Rep1 Lenient

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)

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)))