Copyright	© 2018-2020 IOHK
License	Apache-2.0
Safe Haskell	None
Language	Haskell2010

Data.Text.Class

Contents

Producing and consuming text from arbitrary types
Producing and consuming text from bounded enumeration types
Helpers

Description

Extend the Text module with an extra abstraction to encode and decode values safely to and from Text. It's very similar to FromJSON and ToJSON from Aeson.

Synopsis

class ToText a where
- toText :: a -> Text
class FromText a where
- fromText :: Text -> Either TextDecodingError a
newtype TextDecodingError = TextDecodingError {
- getTextDecodingError :: String
}
fromTextMaybe :: FromText a => Text -> Maybe a
data CaseStyle
- = CamelCase
- | PascalCase
- | KebabLowerCase
- | SnakeLowerCase
- | SnakeUpperCase
- | SpacedLowerCase
toTextFromBoundedEnum :: forall a. (Bounded a, Enum a, Show a) => CaseStyle -> a -> Text
fromTextToBoundedEnum :: forall a. (Bounded a, Enum a, Show a) => CaseStyle -> Text -> Either TextDecodingError a
showT :: ToText a => a -> String
splitAtLastOccurrence :: Char -> Text -> Maybe (Text, Text)

Producing and consuming text from arbitrary types

class ToText a where Source #

Defines a textual encoding for a type.

Methods

toText :: a -> Text Source #

Encode the specified value as text.

Instances

Instances details

ToText String Source #
Instance details Defined in Data.Text.Class Methods toText :: String -> Text Source #
ToText Double Source #
Instance details Defined in Data.Text.Class Methods toText :: Double -> Text Source #
ToText Int Source #
Instance details Defined in Data.Text.Class Methods toText :: Int -> Text Source #
ToText Integer Source #
Instance details Defined in Data.Text.Class Methods toText :: Integer -> Text Source #
ToText Natural Source #
Instance details Defined in Data.Text.Class Methods toText :: Natural -> Text Source #
ToText Word32 Source #
Instance details Defined in Data.Text.Class Methods toText :: Word32 -> Text Source #
ToText Word64 Source #
Instance details Defined in Data.Text.Class Methods toText :: Word64 -> Text Source #
ToText Word31 Source #
Instance details Defined in Data.Text.Class Methods toText :: Word31 -> Text Source #
ToText NominalDiffTime Source #
Instance details Defined in Data.Text.Class Methods toText :: NominalDiffTime -> Text Source #
ToText Text Source #
Instance details Defined in Data.Text.Class Methods toText :: Text -> Text Source #

class FromText a where Source #

Defines a textual decoding for a type.

Methods

fromText :: Text -> Either TextDecodingError a Source #

Decode the specified text as a value.

Instances

Instances details

FromText String Source #
Instance details Defined in Data.Text.Class Methods fromText :: Text -> Either TextDecodingError String Source #
FromText Double Source #
Instance details Defined in Data.Text.Class Methods fromText :: Text -> Either TextDecodingError Double Source #
FromText Int Source #
Instance details Defined in Data.Text.Class Methods fromText :: Text -> Either TextDecodingError Int Source #
FromText Integer Source #
Instance details Defined in Data.Text.Class Methods fromText :: Text -> Either TextDecodingError Integer Source #
FromText Natural Source #
Instance details Defined in Data.Text.Class Methods fromText :: Text -> Either TextDecodingError Natural Source #
FromText Word32 Source #
Instance details Defined in Data.Text.Class Methods fromText :: Text -> Either TextDecodingError Word32 Source #
FromText NominalDiffTime Source #
Instance details Defined in Data.Text.Class Methods fromText :: Text -> Either TextDecodingError NominalDiffTime Source #
FromText Text Source #
Instance details Defined in Data.Text.Class Methods fromText :: Text -> Either TextDecodingError Text Source #

newtype TextDecodingError Source #

Indicates an error that occurred while decoding from text.

Constructors

TextDecodingError
Fields getTextDecodingError :: String

Instances

Instances details

Eq TextDecodingError Source #
Instance details Defined in Data.Text.Class Methods (==) :: TextDecodingError -> TextDecodingError -> Bool Source # (/=) :: TextDecodingError -> TextDecodingError -> Bool Source #
Show TextDecodingError Source #
Instance details Defined in Data.Text.Class Methods showsPrec :: Int -> TextDecodingError -> ShowS Source # show :: TextDecodingError -> String Source # showList :: [TextDecodingError] -> ShowS Source #
Buildable TextDecodingError Source #
Instance details Defined in Data.Text.Class Methods build :: TextDecodingError -> Builder Source #

fromTextMaybe :: FromText a => Text -> Maybe a Source #

Decode the specified text with a Maybe result type.

Producing and consuming text from bounded enumeration types

data CaseStyle Source #

Represents a case style for multi-word strings.

Constructors

CamelCase	A string in the style of "doNotRepeatYourself"
PascalCase	A string in the style of DoNotRepeatYourself
KebabLowerCase	A string in the style of "do-not-repeat-yourself"
SnakeLowerCase	A string in the style of "do_not_repeat_yourself"
SnakeUpperCase	A string in the style of DO_NOT_REPEAT_YOURSELF
SpacedLowerCase	A string in the style of "do not repeat yourself"

Instances

Instances details

Bounded CaseStyle Source #
Instance details Defined in Data.Text.Class Methods minBound :: CaseStyle Source # maxBound :: CaseStyle Source #
Enum CaseStyle Source #
Instance details Defined in Data.Text.Class Methods succ :: CaseStyle -> CaseStyle Source # pred :: CaseStyle -> CaseStyle Source # toEnum :: Int -> CaseStyle Source # fromEnum :: CaseStyle -> Int Source # enumFrom :: CaseStyle -> [CaseStyle] Source # enumFromThen :: CaseStyle -> CaseStyle -> [CaseStyle] Source # enumFromTo :: CaseStyle -> CaseStyle -> [CaseStyle] Source # enumFromThenTo :: CaseStyle -> CaseStyle -> CaseStyle -> [CaseStyle] Source #
Eq CaseStyle Source #
Instance details Defined in Data.Text.Class Methods (==) :: CaseStyle -> CaseStyle -> Bool Source # (/=) :: CaseStyle -> CaseStyle -> Bool Source #
Show CaseStyle Source #
Instance details Defined in Data.Text.Class Methods showsPrec :: Int -> CaseStyle -> ShowS Source # show :: CaseStyle -> String Source # showList :: [CaseStyle] -> ShowS Source #
Generic CaseStyle Source #
Instance details Defined in Data.Text.Class Associated Types type Rep CaseStyle :: Type -> Type Source # Methods from :: CaseStyle -> Rep CaseStyle x Source # to :: Rep CaseStyle x -> CaseStyle Source #
type Rep CaseStyle Source #
Instance details Defined in Data.Text.Class type Rep CaseStyle = D1 ('MetaData "CaseStyle" "Data.Text.Class" "text-class-2020.12.8-ElEe3MRO78w61aozUBjmEU" 'False) ((C1 ('MetaCons "CamelCase" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "PascalCase" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "KebabLowerCase" 'PrefixI 'False) (U1 :: Type -> Type))) :+: (C1 ('MetaCons "SnakeLowerCase" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "SnakeUpperCase" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "SpacedLowerCase" 'PrefixI 'False) (U1 :: Type -> Type))))

toTextFromBoundedEnum :: forall a. (Bounded a, Enum a, Show a) => CaseStyle -> a -> Text Source #

Converts the given value to text, according to the specified CaseStyle.

This function guarantees to satisfy the following property:

fromTextToBoundedEnum s (toTextFromBoundedEnum s a) == Right a

fromTextToBoundedEnum :: forall a. (Bounded a, Enum a, Show a) => CaseStyle -> Text -> Either TextDecodingError a Source #

Parses the given text to a value, according to the specified CaseStyle.

This function guarantees to satisfy the following property:

fromTextToBoundedEnum s (toTextFromBoundedEnum s a) == Right a

Helpers

showT :: ToText a => a -> String Source #

Show a data-type through its ToText instance

splitAtLastOccurrence :: Char -> Text -> Maybe (Text, Text) Source #

Splits the given Text into a prefix and a suffix using the last occurrence of the specified separator character as a splitting point. Evaluates to Nothing if the specified Text does not contain the separator character.