Data.Text.Internal.Lazy

Warning: this is an internal module, and does not have a stable API or name. Functions in this module may not check or enforce preconditions expected by public modules. Use at your own risk!

A module containing private Text internals. This exposes the Text representation and low level construction functions. Modules which extend the Text system may need to use this module.

Documentation

data Text

Constructors

Empty

Chunk !Text Text

Instances

IsList Text

Since: 1.2.0.0

Defined in Data.Text.Lazy

Associated Types

type Item Text :: Type

Methods

fromList :: [Item Text] -> Text

fromListN :: Int -> [Item Text] -> Text

toList :: Text -> [Item Text]

Eq Text

Defined in Data.Text.Lazy

Methods

(==) :: Text -> Text -> Bool

(/=) :: Text -> Text -> Bool

Data Text

This instance preserves data abstraction at the cost of inefficiency. We omit reflection services for the sake of data abstraction.

This instance was created by copying the updated behavior of Data.Text.Text

Defined in Data.Text.Lazy

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Text -> c Text

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Text

toConstr :: Text -> Constr

dataTypeOf :: Text -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Text)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Text)

gmapT :: (forall b. Data b => b -> b) -> Text -> Text

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Text -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Text -> r

gmapQ :: (forall d. Data d => d -> u) -> Text -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Text -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Text -> m Text

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Text -> m Text

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Text -> m Text

Ord Text

Defined in Data.Text.Lazy

Methods

compare :: Text -> Text -> Ordering

(<) :: Text -> Text -> Bool

(<=) :: Text -> Text -> Bool

(>) :: Text -> Text -> Bool

(>=) :: Text -> Text -> Bool

max :: Text -> Text -> Text

min :: Text -> Text -> Text

Read Text

Defined in Data.Text.Lazy

Methods

readsPrec :: Int -> ReadS Text

readList :: ReadS [Text]

readPrec :: ReadPrec Text

readListPrec :: ReadPrec [Text]

Show Text

Defined in Data.Text.Lazy

Methods

showsPrec :: Int -> Text -> ShowS

show :: Text -> String

showList :: [Text] -> ShowS

IsString Text

Defined in Data.Text.Lazy

Methods

fromString :: String -> Text

Semigroup Text

Non-orphan Semigroup instance only defined for base-4.9.0.0 and later; orphan instances for older GHCs are provided by the semigroups package

Since: 1.2.2.0

Defined in Data.Text.Lazy

Methods

(<>) :: Text -> Text -> Text

sconcat :: NonEmpty Text -> Text

stimes :: Integral b => b -> Text -> Text

Monoid Text

Defined in Data.Text.Lazy

Methods

mempty :: Text

mappend :: Text -> Text -> Text

mconcat :: [Text] -> Text

Lift Text

This instance has similar considerations to the Data instance: it preserves abstraction at the cost of inefficiency.

Since: 1.2.4.0

Defined in Data.Text.Lazy

Methods

lift :: Text -> Q Exp

PrintfArg Text

Only defined for base-4.7.0.0 and later

Since: 1.2.2.0

Defined in Data.Text.Lazy

Methods

formatArg :: Text -> FieldFormatter

parseFormat :: Text -> ModifierParser

Binary Text

Since: 1.2.1.0

Defined in Data.Text.Lazy

Methods

put :: Text -> Put

get :: Get Text

putList :: [Text] -> Put

NFData Text

Defined in Data.Text.Lazy

Methods

rnf :: Text -> ()

type Item Text

Defined in Data.Text.Lazy

type Item Text = Char

chunk :: Text -> Text -> Text

Smart constructor for Chunk. Guarantees the data type invariant.

empty :: Text

Smart constructor for Empty.

foldrChunks :: (Text -> a -> a) -> a -> Text -> a

Consume the chunks of a lazy Text with a natural right fold.

foldlChunks :: (a -> Text -> a) -> a -> Text -> a

Consume the chunks of a lazy Text with a strict, tail-recursive, accumulating left fold.

Data type invariant and abstraction functions

The data type invariant for lazy Text: Every Text is either Empty or consists of non-null Texts. All functions must preserve this, and the QC properties must check this.

strictInvariant :: Text -> Bool

Check the invariant strictly.

lazyInvariant :: Text -> Text

Check the invariant lazily.

showStructure :: Text -> String

Display the internal structure of a lazy Text.

Chunk allocation sizes

defaultChunkSize :: Int

Currently set to 16 KiB, less the memory management overhead.

smallChunkSize :: Int

Currently set to 128 bytes, less the memory management overhead.

chunkOverhead :: Int

The memory management overhead. Currently this is tuned for GHC only.