text-show
Efficient conversion of values into Text
https://github.com/RyanGlScott/text-show
Version on this page: | 2.1.2@rev:2 |
LTS Haskell 22.41: | 3.10.5@rev:2 |
Stackage Nightly 2024-11-12: | 3.11 |
Latest on Hackage: | 3.11 |
text-show-2.1.2@sha256:b3b37a10589923b91729f07291795acf58f98efd5df1f32de99ab27fa1d3eda3,15645
Module documentation for 2.1.2
- TextShow
- TextShow.Control
- TextShow.Data
- TextShow.Data.Array
- TextShow.Data.Bool
- TextShow.Data.ByteString
- TextShow.Data.Char
- TextShow.Data.Complex
- TextShow.Data.Data
- TextShow.Data.Dynamic
- TextShow.Data.Either
- TextShow.Data.Fixed
- TextShow.Data.Floating
- TextShow.Data.Functor
- TextShow.Data.Integral
- TextShow.Data.List
- TextShow.Data.Maybe
- TextShow.Data.Monoid
- TextShow.Data.OldTypeable
- TextShow.Data.Ord
- TextShow.Data.Proxy
- TextShow.Data.Ratio
- TextShow.Data.Text
- TextShow.Data.Tuple
- TextShow.Data.Type
- TextShow.Data.Typeable
- TextShow.Data.Version
- TextShow.Data.Void
- TextShow.Debug
- TextShow.Foreign
- TextShow.Foreign.C
- TextShow.Foreign.Ptr
- TextShow.Functions
- TextShow.GHC
- TextShow.Generic
- TextShow.Numeric
- TextShow.System
- TextShow.System.Exit
- TextShow.System.IO
- TextShow.System.Posix
- TextShow.TH
- TextShow.Text
text-show
text-show
offers a replacement for the Show
typeclass intended for use with Text
instead of String
s. This package was created in the spirit of bytestring-show
.
At the moment, text-show
provides instances for most data types in the array
, base
, bytestring
, and text
packages. Therefore, much of the source code for text-show
consists of borrowed code from those packages in order to ensure that the behaviors of Show
and TextShow
coincide.
For most uses, simply importing TextShow
will suffice:
module Main where
import TextShow
main :: IO ()
main = printT (Just "Hello, World!")
If you desire it, there are also monomorphic versions of the showb
function available in the submodules of Text.Show.Text
. See the naming conventions page for more information.
Support for automatically deriving TextShow
instances can be found in the TextShow.TH
and TextShow.Generic
modules.
Changes
2.1.2
- Fixed GHC 7.10.3 build
- Extended
TextShow.Generic
to allowgenericShowbPrec
(and friends) to be used onGeneric
datatypes withChar#
,Double#
,Float#
,Int#
, andWord#
argument types, just like stringShow
does - Added
Generic1
instances forFromStringShow
andFromTextShow
- Added
TextShow
instances forUChar
,UDouble
,UFloat
,UInt
, andUWord
inTextShow.GHC.Generics
2.1.1
- Restore support for
semigroups-0.16.1
2.1
- Require
semigroups
>= 0.17 - Added
showsToShowb
andshowbToShows
toTextShow
- Added
TextShow1 FromStringShow
instance - Added
showbGiveGCStats
,showbDoCostCentres
,showbDoHeapProfile
, andshowbDoTrace
toTextShow.GHC.RTS.Flags
if usingbase-4.8.2
or later - Exported
showbDownPrecWith
on earlier versions of GHC - Fixed mistakes in TH error output
- Make
Proxy
,Coercion
, and(:~:)
instances poly-kinded - Changed implementation of
showbByteStringStrict
,showbByteStrictLazy(Prec)
,showbShortByteString
(inTextShow.Data.ByteString
),showbThreadIdPrec
(inTextShow.Control.Concurrent
),showbEvent
, andshowbFdKeyPrec
(inTextShow.GHC.Event
) to avoid usingString
s as an intermediary
2
- Changed the top-level module name from
Text.Show.Text
toTextShow
, since the former was extremely verbose without much benefit. As a result, this will break all existing code that depends ontext-show
. - Several typeclasses and functions were renamed so as to not to clash with the
Prelude
: Show
→TextShow
Show1
→TextShow1
Show2
→TextShow2
show
→showt
showLazy
→showtl
showPrec
→showtPrec
showPrecLazy
→showtlPrec
showList
→showtList
showListLazy
→showtlList
print
→printT
printLazy
→printTL
hPrint
→hPrintT
hPrintLazy
→hPrintTL
GShow
→GTextShow
GShow1
→GTextShow1
genericShow
→genericShowt
genericShowLazy
→genericShowtl
genericShowPrec
→genericShowtPrec
genericShowPrecLazy
→genericShowtlPrec
genericShowList
→genericShowtList
genericShowListLazy
→genericShowtlList
genericPrint
→genericPrintT
genericPrintLazy
→genericPrintTL
genericHPrint
→genericHPrintT
genericHPrintLazy
→genericHPrintTL
deriveShow
→deriveTextShow
deriveShow1
→deriveTextShow1
deriveShow2
→deriveTextShow2
mkShow
→makeShowt
mkShowLazy
→makeShowtl
mkShowPrec
→makeShowtPrec
mkShowPrecLazy
→makeShowtlPrec
mkShowList
→makeShowtList
mkShowListLazy
→makeShowtlList
mkShowb
→makeShowb
mkShowbPrec
→makeShowbPrec
mkShowbList
→makeShowbList
mkPrint
→makePrintT
mkPrintLazy
→makePrintTL
mkHPrint
→makeHPrintT
mkHPrintLazy
→makeHPrintTL
mkShowbPrecWith
→makeShowbPrecWith
mkShowbPrec1
→makeShowbPrec1
mkShowbPrecWith2
→makeShowbPrecWith2
mkShowbPrec2
→makeShowbPrec2
trace
→tracet
traceLazy
→tracetl
traceId
→tracetId
traceIdLazy
→tracetlId
traceShow
→traceTextShow
traceShowId
→traceTextShowId
traceStack
→tracetStack
traceStackLazy
→tracetlStack
traceIO
→tracetIO
traceIOLazy
→tracetlIO
traceM
→tracetM
traceMLazy
→tracetlM
traceShowM
→traceTextShowM
traceEvent
→tracetEvent
traceEventLazy
→tracetlEvent
traceEventIO
→travetEventIO
traceEventIOLazy
→tracetlEventIO
traceMarker
→tracetMarker
traceMarkerLazy
→tracetlMarker
traceMarkerIO
→tracetMarkerIO
traceMarkerIOLazy
→tracetlMarkerIO
genericTraceShow
→genericTraceTextShow
genericTraceShowId
→genericTraceTextShowId
genericTraceShowM
→genericTraceTextShowM
mkTraceShow
→makeTraceTextShow
mkTraceShowId
→makeTraceTextShowId
mkTraceShowM
→makeTraceTextShowM
- Added
TextShow Lifetime
instance inTextShow.GHC.Event
(if usingbase-4.8.1.0
or later) - Generalized
tracetM
,tracetlM
, andtraceTextShowM
to use anApplicative
constraint instead ofMonad
- Fixed a bug in which the
TextShow(1)
instances forProxy
,(:~:)
, andCoercion
didn’t use-XPolyKinds
- Fixed a bug in the Template Haskell deriver which would cause
deriveTextShow
to fail on type parameters with sufficiently high kinds
1
- The
Show1
class has been completely overhauled.Show1
now uses the functionshowbPrecWith
, which takes as an argument a function of typeInt -> a -> Builder
to show occurrences of the type parameter (instead of requiring the type parameter to be aShow
instance). This matches the new implementation ofShow1
in the next version oftransformers
. A similarShow2
class (with the functionshowbPrecWith2
) was also added. - As a consequence,
Show1
instances should no longer be defined in terms ofshowbPrec
; rather,Show
instances should be defined in terms ofshowbPrecWith
orshowbPrecWith2
, andShow1
instances can be defined in terms ofshowbPrecWith2
. - The
showbPrec1
function is no longer a class method ofShow1
, but is now a standalone function defined in terms ofshowbPrecWith
.showbPrec1
can be useful for definingShow
instances. A similarshowbPrec2
function was also added. - The monomorphic functions in the many submodules of this package have been generalized (where possible) to use
Show1
andShow2
instances. These functions have-PrecWith
and-PrecWith2
suffixes, respectively. - Because of the generality of the new
showPrecWith
function,Show1
instances are now possible forRatio
,Alt
,Rec1
,M1
,(:+:)
,(:*:)
, and(:.:)
. - Removed many silly instances for
FromStringShow
andFromTextShow
, since they’ll never be used in the ways suggested by those instances to begin with. - The Template Haskell engine has been completely overhauled. Deriving
Show1
andShow2
instances are now possible using thederiveShow1
andderiveShow2
functions. See the documentation inText.Show.Text.TH
for more details. In addition, themkShowbPrecWith
,mkShowbPrec1
,mkShowbPrecWith2
, andmkShowbPrec2
functions were added. - Removed the ability to call
deriveShow
ormkShowbPrec
(or other functions prefixed withmk-
) using a data family name. This is considered a misfeature. If you want to deriveShow
for data family instances, use the correspondingdata instance
ornewtype instance
constructor name as an argument instead. - Removed
PragmaOptions
,deriveShowPragmas
,defaultInlineShowbPrec
,defaultInlineShowb
, anddefaultInlineShowbList
, as it was impossible to make Template Haskell-generated pragmas work consistently across different versions of GHC. If you really want to useINLINE
andSPECIALIZE instance
pragmas with your Template Haskell-generated code, create manual instances withmkShowbPrec
and family. Show1
instances can now be created generically using thegenericShowbPrecWith
function inText.Show.Text.Generics
. AgenericShowbPrec1
was also added.- Added
generic-deriving
as a dependency, which allows generics-related code to be exported on more versions of GHC ConType
(inText.Show.Text.Generics
) now has anInf String
constructor instead ofInf Builder
. As a result,ConType
now always anEq
andOrd
instance, and aRead ConType
instance was added.Typeable
instances for the promoted data constructors'FromStringShow
and'FromTextShow
- Added
showbFPFormat
toText.Show.Text.Data.Floating
- Revamped test suite
0.8.1.1
- Retroactive
CHANGELOG
update
0.8.1
- Fix test suite build with older versions of
QuickCheck
0.8
- Exported
formatRealFloatB
andformatRealFloatAltB
fromText.Show.Text.Data.Floating
. ReexportedFPFormat
(fromtext
) in the same module, and added aText
Show
instance for it. - The
Show
instance forRatio a
now only requires aShow a
constraint if usingbase-4.4.0.0
or later (if usingbase-4.3.0.0
, it requires a(Show a, Integral a)
constraint) - Added
showbSingPrec
toText.Show.Text.GHC.TypeLits
(if usingbase-4.6
) - Modules which were previously exported only if using a recent-enough version of GHC/
base
(e.g.,Text.Show.Text.GHC.Generics
) are now always exposed. If the functionality that the module provides is not available on a given version of GHC/base
, the module will not expose anything. - Bump lower version bounds of
text
to 0.11.1 due to reexportingFPFormat
- Added
showbUnicodeException
,showbI16Prec
,showbDecodingPrec
, andshowbSizePrec
functions (and correspondingShow
instances) toText.Show.Text.Data.Text
- Made
GShow
inText.Show.Text.Generics
poly-kinded - The Template Haskell deriver (and
GShow
) now handles “infix” data constructors that are applied as prefix correctly (e.g.,data Amp a = (:&) a a
) - The Template Haskell deriver now handles showable unlifted types (
Char#
,Double#
,Float#
,Int#
, andWord#
) correctly on GHC 7.11 and later - The Template Haskell derive now does not parenthesize record types regardless of precedence on GHC 7.11 and later
- Fixed build on GHC 7.2
- Changed test-suite to use
hspec
, which allows for it to be built on GHC 7.0 and 7.2
0.7.0.1
- Disabled
print
-related tests, as they sporadically break referential transparency for unknown reasons - Fixed build on Windows
0.7
- Added
showbConstPrec
(and correspondingShow
andShow1
instances forConst
) toText.Show.Text.Control.Applicative
- Added
showbUArrayPrec
(and correspondingShow
instance forUArray
s) andshowbIArrayPrec
toText.Data.Text.Data.Array
. - Renamed
showbListDefault
toshowbListWith
to match howText.Show
names it - Exposed
showbShortByteString
with all versions ofbytestring
by using thebytestring-builder
package - Corrected the
Show
instance forLexeme
(inText.Show.Text.Text.Read.Lex
) - Fixed
TypeRep
output on GHC 7.10 and later - Removed
LitChar
andLitString
fromText.Show.Text.Data.Char
, as they were not as useful as I had imagined. - Removed the deprecated
replicateB
function Typable
instances forShow
,Show1
, andGShow
(with GHC 7.8 and later)Typeable
instance forConType
- Only derive
Eq
andOrd
forConType
if a recent-enough version oftext
is used - Changed the implementations of some functions in
Text.Show.Text.Debug.Trace
to useByteString
s instead ofString
s
0.6.0.1
- Forgot to include some header files in
text-show.cabal
0.6
deriveShow
can now construct instances for data families, using either the data family name or a data instance constructor as an argument. See the documentation inText.Show.Text.TH
for more details.- Fixed a bug in which infix backticked data constructors (e.g.,
data Add = Int `Plus` Int
) would not be shown correctly. - Fixed typo in
Text.Show.Text.GHC.RTS.Flags
- Removed the phantom-type detecting mechanism with
template-haskell-2.9.0.0
or higher. This method of finding phantom types is intrinsically flawed and is not usable on older GHCs. - Added generics support with the
Text.Show.Text.Generic
andText.Show.Text.Debug.Trace.Generic
modules - Deprecated
replicateB
in favor oftimesN
from thesemigroups
library - Added
FromTextShow
toText.Show.Text
, which admits aString
Show
instance for any data type with aText
Show
instance (the counterpart ofFromStringShow
) - Added
Monoid
andSemigroup
instances forFromStringShow
,Semigroup
instance forLitString
,IsChar
instance forLitChar
, andIsString
instance for[LitChar]
- Changed the
String
Show
instances ofFromStringShow
,LitChar
, andLitString
to more closely match theText
Show
instances. As a result, theRead
instances for these data types were also changed so thatread . show = read . show = id
. - Removed the
recent-text
flag. We’ll allow users to build with older versions oftext
, but the latest version is recommended. Because of this, theinteger-simple
andinteger-gmp
flags are not needed. - Removed the
integer-gmp2
flag, as it supported a configuration that didn’t actually compile on GHC - Removed the
transformers-four
flag, as it is not needed now thattransformers-compat
is a dependency
0.5
- Fix build for GHC 7.10, old GHC versions, and Windows
- Removed the
Text.Show.Text.Data.Containers
andText.Show.Text.Data.Time
modules. The modules for the data types incontainers
andtime
were migrated to a separate library,text-show-instances
. - Removed the
-ftext-format
flag, astext-show
no longer usestext-format
. - A serious bug in the
text
package that caused segfaults when building largeInteger
s was fixed intext-1.2.0.2
. A flag (-frecent-text
) was added that allows you to take advantage of this. - Fixed a bug that would cause the output of functions in the
Text.Show.Text.Data.Floating
module to not matchbase
depending on what version ofbase
is used. - The type signatures of lambda expressions generated by
mkShow
and related functions were loosened to allow them to be used to “manually” deriveShow
instances for data types with higher-kinded type parameters or type arguments with restrictedShow
instances. This should not be a breaking change; you can simply do more withmkShow
et al. than you could before. For more information, see the documentation inText.Show.Text.TH
. - Loosened the
Show
instance ofComplex a
to only depend onShow a
(previously requiredRealFloat a
) if using base-4.4.0.0 or later - Moved
showbRatioPrec
toText.Show.Text.Data.Ratio
,showbComplexPrec
toText.Show.Text.Data.Complex
,showbProxy
toText.Show.Text.Data.Proxy
, andshowbFingerprint
toText.Show.Text.GHC.Fingerprint
- Added
deriveShowPragmas
toText.Show.Text.TH
to allow users to specifyINLINE
orSPECIALIZE instance
pragmas withShow
instances. - Added
FromStringShow
,showbSpace
,showbUnary
,showbUnary1
, andshowbBinary1
toText.Show.Text
- Added
mkShowList
,mkShowListLazy
, andmkShowbList
toText.Data.Text.TH
- For base-4.8.0.0 and above, added the
Text.Show.Text.Data.Functor.Identity
,Text.Show.Text.Data.Void
,Text.Show.Text.GHC.RTS.Flags
,Text.Show.Text.GHC.StaticPtr
, andText.Show.Text.Numeric.Natural
modules. Also addedShow
instances forAllocationLimitExceeded
inText.Show.Text.Control.Exception
andAlt
inText.Show.Text.Data.Monoid
. Also fixed theShow
instance forFixed
values. - Added the
Text.Show.Text.Data.GHC.Conc.Windows
module (Windows-only) - Added the
Text.Show.Text.Data.OldTypeable
module for base-4.7 - Added the
Text.Show.Text.GHC.TypeLits
module for base-4.6 and above - Added the
Text.Show.Text.Debug.Trace
andText.Show.Text.Debug.Trace.TH
modules as an analog toDebug.Trace
- Added the
Show1
class and corresponding instances for unary type constructors. - Added
LitChar
andLitString
toText.Show.Text.Data.Char
- Exported
asciiTabB
inText.Show.Text.Data.Char
- Renamed
showbTextStrict
to ‘showbText’ (to keep with naming conventions in thetext
library) and addedshowbBuilder
toText.Show.Text.Data.Text
.
0.4.1
- Added the utility functions
toText
andtoString
for working withBuilder
s.
0.4
- Due to GHC bug #5289, projects that depend on the
double-conversion
library (such astext-format
, a dependency oftext-show
) may break due to GHC incorrectly linking against libstdc++. Therefore,text-show
was changed so that it does not depend ontext-format
by default. This behavior can be changed by using the-ftext-format
flag when usingcabal
. - Added
showbZonedTime
toText.Show.Text.Data.Time
(and correspondingShow
instance forZonedTime
) - Exposed
showbMaskingState
(is was already there, I just forgot to export it) - If using GHC 7.6 or earlier, depend on tagged so that
Data.Proxy
(and thusshowbProxy
fromText.Show.Text.Data.Typeable
) can be used - Refactored code to use Template Haskell derivations when possible
0.3.1.0
- Added
showList
andshowListLazy
- Don’t use
showbListDefault
to showcontainers
data types - Added the ability to splice
show
functions for arbitrary data types (even if they aren’tShow
instances). These functions aremkShow
,mkShowLazy
,mkShowPrec
,mkShowPrecLazy
,mkShowb
,mkShowbPrec
,mkPrint
,mkPrintLazy
,mkHPrint
, andmkHPrintLazy
.
0.3.0.0
- Lots of bugfixes
Show
instances for many other data types inbase
,containers
andtime
- Exposed internal modules with monomorphic functions
Text.Show.Text
now exportsData.Text.Lazy.Builder
for convenience- Add
showLazy
,showPrec
,showPrecLazy
,printLazy
,hPrint
,hPrintLazy
,lengthB
, andreplicateB
- Template Haskell derivation of
Show
instances (doesn’t support data families yet)
0.2.0.0
- Added
Show
instances for strict and lazyText
0.1.0.0
- Initial commit