Safe Haskell	Safe-Inferred
Language	Haskell2010

Data.String.Conv

Synopsis

class StringConv a b where
- strConv :: Leniency -> a -> b
toS :: StringConv a b => a -> b
toSL :: StringConv a b => a -> b
convS :: (StringConv a b, StringConv b a, Functor f) => (b -> f b) -> a -> f a
convSL :: (StringConv a b, StringConv b a, Functor f) => (b -> f b) -> a -> f a
data Leniency
- = Lenient
- | Strict

Documentation

class StringConv a b where Source #

A type class to standardize string conversions. With this type class you only need to remember one function for converting between any two string variants. This package includes support for String, ByteString, and Text as well as the Lazy and Strict variants where necessary.

This type class lets you control how conversion should behave when failure is possible. Strict mode will cause an exception to be thrown when decoding fails. Lenient mode will attempt to recover, inserting a replacement character for invalid bytes.

StringConv's toS function is most useful when you have a fully defined string conversion with a fixed (non-polymorphic) input and output type. Of course you can still use it when you don't have a fixed type. In that case you might need to specify a type class constraint such as StringConv s String.

Methods

strConv :: Leniency -> a -> b Source #

Instances

Instances details

StringConv String String Source #
Instance details Defined in Data.String.Conv Methods strConv :: Leniency -> String -> String Source #
StringConv String ByteString Source #
Instance details Defined in Data.String.Conv Methods strConv :: Leniency -> String -> ByteString Source #
StringConv String ByteString Source #
Instance details Defined in Data.String.Conv Methods strConv :: Leniency -> String -> ByteString Source #
StringConv String Text Source #
Instance details Defined in Data.String.Conv Methods strConv :: Leniency -> String -> Text Source #
StringConv String Text Source #
Instance details Defined in Data.String.Conv Methods strConv :: Leniency -> String -> Text Source #
StringConv ByteString String Source #
Instance details Defined in Data.String.Conv Methods strConv :: Leniency -> ByteString -> String Source #
StringConv ByteString ByteString Source #
Instance details Defined in Data.String.Conv Methods strConv :: Leniency -> ByteString -> ByteString Source #
StringConv ByteString ByteString Source #
Instance details Defined in Data.String.Conv Methods strConv :: Leniency -> ByteString0 -> ByteString Source #
StringConv ByteString Text Source #
Instance details Defined in Data.String.Conv Methods strConv :: Leniency -> ByteString -> Text Source #
StringConv ByteString Text Source #
Instance details Defined in Data.String.Conv Methods strConv :: Leniency -> ByteString -> Text Source #
StringConv ByteString String Source #
Instance details Defined in Data.String.Conv Methods strConv :: Leniency -> ByteString -> String Source #
StringConv ByteString ByteString Source #
Instance details Defined in Data.String.Conv Methods strConv :: Leniency -> ByteString -> ByteString0 Source #
StringConv ByteString ByteString Source #
Instance details Defined in Data.String.Conv Methods strConv :: Leniency -> ByteString -> ByteString Source #
StringConv ByteString Text Source #
Instance details Defined in Data.String.Conv Methods strConv :: Leniency -> ByteString -> Text Source #
StringConv ByteString Text Source #
Instance details Defined in Data.String.Conv Methods strConv :: Leniency -> ByteString -> Text Source #
StringConv Text String Source #
Instance details Defined in Data.String.Conv Methods strConv :: Leniency -> Text -> String Source #
StringConv Text ByteString Source #
Instance details Defined in Data.String.Conv Methods strConv :: Leniency -> Text -> ByteString Source #
StringConv Text ByteString Source #
Instance details Defined in Data.String.Conv Methods strConv :: Leniency -> Text -> ByteString Source #
StringConv Text Text Source #
Instance details Defined in Data.String.Conv Methods strConv :: Leniency -> Text -> Text Source #
StringConv Text Text Source #
Instance details Defined in Data.String.Conv Methods strConv :: Leniency -> Text0 -> Text Source #
StringConv Text String Source #
Instance details Defined in Data.String.Conv Methods strConv :: Leniency -> Text -> String Source #
StringConv Text ByteString Source #
Instance details Defined in Data.String.Conv Methods strConv :: Leniency -> Text -> ByteString Source #
StringConv Text ByteString Source #
Instance details Defined in Data.String.Conv Methods strConv :: Leniency -> Text -> ByteString Source #
StringConv Text Text Source #
Instance details Defined in Data.String.Conv Methods strConv :: Leniency -> Text -> Text0 Source #
StringConv Text Text Source #
Instance details Defined in Data.String.Conv Methods strConv :: Leniency -> Text -> Text Source #

toS :: StringConv a b => a -> b Source #

Universal string conversion function for strict decoding.

toSL :: StringConv a b => a -> b Source #

Universal string conversion function for lenient decoding.

convS :: (StringConv a b, StringConv b a, Functor f) => (b -> f b) -> a -> f a Source #

A lens for toS to make it slightly more convenient in some scenarios.

convSL :: (StringConv a b, StringConv b a, Functor f) => (b -> f b) -> a -> f a Source #

A lens for toSL to make it slightly more convenient in some scenarios.

data Leniency Source #

Data type representing the two leniency modes defining how decoding failure is handled.

Constructors

Lenient
Strict

Instances

Instances details

Bounded Leniency Source #
Instance details Defined in Data.String.Conv Methods minBound :: Leniency # maxBound :: Leniency #
Enum Leniency Source #
Instance details Defined in Data.String.Conv Methods succ :: Leniency -> Leniency # pred :: Leniency -> Leniency # toEnum :: Int -> Leniency # fromEnum :: Leniency -> Int # enumFrom :: Leniency -> [Leniency] # enumFromThen :: Leniency -> Leniency -> [Leniency] # enumFromTo :: Leniency -> Leniency -> [Leniency] # enumFromThenTo :: Leniency -> Leniency -> Leniency -> [Leniency] #
Eq Leniency Source #
Instance details Defined in Data.String.Conv Methods (==) :: Leniency -> Leniency -> Bool # (/=) :: Leniency -> Leniency -> Bool #
Ord Leniency Source #
Instance details Defined in Data.String.Conv Methods compare :: Leniency -> Leniency -> Ordering # (<) :: Leniency -> Leniency -> Bool # (<=) :: Leniency -> Leniency -> Bool # (>) :: Leniency -> Leniency -> Bool # (>=) :: Leniency -> Leniency -> Bool # max :: Leniency -> Leniency -> Leniency # min :: Leniency -> Leniency -> Leniency #
Read Leniency Source #
Instance details Defined in Data.String.Conv Methods readsPrec :: Int -> ReadS Leniency # readList :: ReadS [Leniency] # readPrec :: ReadPrec Leniency # readListPrec :: ReadPrec [Leniency] #
Show Leniency Source #
Instance details Defined in Data.String.Conv Methods showsPrec :: Int -> Leniency -> ShowS # show :: Leniency -> String # showList :: [Leniency] -> ShowS #