Copyright	Copyright (c) 2019-2025 Travis Cardwell
License	MIT
Safe Haskell	Safe-Inferred
Language	Haskell2010

Data.TTC.Wrapper

Contents

Wrapper Types

Description

This module defines a newtype wrapper for each Textual data type. Each wrapper has a Render instance that converts the wrapped type and a Parse instance that wraps the argument (never failing). Data types that are coercible to a Textual data type can use these wrappers to derive instances using DerivingVia.

See the wrapper example program in the ttc-examples directory of the source repository.

Synopsis

newtype WrapperS = WrapperS {
- unWrapperS :: String
}
newtype WrapperT = WrapperT {
- unWrapperT :: Text
}
newtype WrapperTL = WrapperTL {
- unWrapperTL :: Text
}
newtype WrapperTLB = WrapperTLB {
- unWrapperTLB :: Builder
}
newtype WrapperST = WrapperST {
- unWrapperST :: ShortText
}
newtype WrapperBS = WrapperBS {
- unWrapperBS :: ByteString
}
newtype WrapperBSL = WrapperBSL {
- unWrapperBSL :: ByteString
}
newtype WrapperBSB = WrapperBSB {
- unWrapperBSB :: Builder
}
newtype WrapperSBS = WrapperSBS {
- unWrapperSBS :: ShortByteString
}

Wrapper Types

newtype WrapperS Source #

String wrapper type

Since: 1.5.0.0

Constructors

WrapperS
Fields unWrapperS :: String

Instances

Instances details

Parse WrapperS Source #
Instance details Defined in Data.TTC.Wrapper Methods parse :: (Textual t, Textual e) => t -> Either e WrapperS Source #
Render WrapperS Source #
Instance details Defined in Data.TTC.Wrapper Methods render :: Textual t => WrapperS -> t Source #

newtype WrapperT Source #

Strict Text wrapper type

Since: 1.5.0.0

Constructors

WrapperT
Fields unWrapperT :: Text

Instances

Instances details

Parse WrapperT Source #
Instance details Defined in Data.TTC.Wrapper Methods parse :: (Textual t, Textual e) => t -> Either e WrapperT Source #
Render WrapperT Source #
Instance details Defined in Data.TTC.Wrapper Methods render :: Textual t => WrapperT -> t Source #

newtype WrapperTL Source #

Lazy Text wrapper type

Since: 1.5.0.0

Constructors

WrapperTL
Fields unWrapperTL :: Text

Instances

Instances details

Parse WrapperTL Source #
Instance details Defined in Data.TTC.Wrapper Methods parse :: (Textual t, Textual e) => t -> Either e WrapperTL Source #
Render WrapperTL Source #
Instance details Defined in Data.TTC.Wrapper Methods render :: Textual t => WrapperTL -> t Source #

newtype WrapperTLB Source #

Text Builder wrapper type

Since: 1.5.0.0

Constructors

WrapperTLB
Fields unWrapperTLB :: Builder

Instances

Instances details

Parse WrapperTLB Source #
Instance details Defined in Data.TTC.Wrapper Methods parse :: (Textual t, Textual e) => t -> Either e WrapperTLB Source #
Render WrapperTLB Source #
Instance details Defined in Data.TTC.Wrapper Methods render :: Textual t => WrapperTLB -> t Source #

newtype WrapperST Source #

ShortText wrapper type

Since: 1.5.0.0

Constructors

WrapperST
Fields unWrapperST :: ShortText

Instances

Instances details

Parse WrapperST Source #
Instance details Defined in Data.TTC.Wrapper Methods parse :: (Textual t, Textual e) => t -> Either e WrapperST Source #
Render WrapperST Source #
Instance details Defined in Data.TTC.Wrapper Methods render :: Textual t => WrapperST -> t Source #

newtype WrapperBS Source #

Strict ByteString wrapper type

Since: 1.5.0.0

Constructors

WrapperBS
Fields unWrapperBS :: ByteString

Instances

Instances details

Parse WrapperBS Source #
Instance details Defined in Data.TTC.Wrapper Methods parse :: (Textual t, Textual e) => t -> Either e WrapperBS Source #
Render WrapperBS Source #
Instance details Defined in Data.TTC.Wrapper Methods render :: Textual t => WrapperBS -> t Source #

newtype WrapperBSL Source #

Lazy ByteString wrapper type

Since: 1.5.0.0

Constructors

WrapperBSL
Fields unWrapperBSL :: ByteString

Instances

Instances details

Parse WrapperBSL Source #
Instance details Defined in Data.TTC.Wrapper Methods parse :: (Textual t, Textual e) => t -> Either e WrapperBSL Source #
Render WrapperBSL Source #
Instance details Defined in Data.TTC.Wrapper Methods render :: Textual t => WrapperBSL -> t Source #

newtype WrapperBSB Source #

ByteString Builder wrapper type

Since: 1.5.0.0

Constructors

WrapperBSB
Fields unWrapperBSB :: Builder

Instances

Instances details

Parse WrapperBSB Source #
Instance details Defined in Data.TTC.Wrapper Methods parse :: (Textual t, Textual e) => t -> Either e WrapperBSB Source #
Render WrapperBSB Source #
Instance details Defined in Data.TTC.Wrapper Methods render :: Textual t => WrapperBSB -> t Source #

newtype WrapperSBS Source #

ShortByteString wrapper type

Since: 1.5.0.0

Constructors

WrapperSBS
Fields unWrapperSBS :: ShortByteString

Instances

Instances details

Parse WrapperSBS Source #
Instance details Defined in Data.TTC.Wrapper Methods parse :: (Textual t, Textual e) => t -> Either e WrapperSBS Source #
Render WrapperSBS Source #
Instance details Defined in Data.TTC.Wrapper Methods render :: Textual t => WrapperSBS -> t Source #