text-short

Memory-efficient representation of Unicode text strings

Version on this page:	0.1.5@rev:1
LTS Haskell 20.16:	0.1.5@rev:2
Stackage Nightly 2023-03-31:	0.1.5@rev:2
Latest on Hackage:	0.1.5@rev:2

See all snapshots text-short appears in

BSD-3-Clause licensed by Herbert Valerio Riedel

Maintained by hvr@gnu.org

This version can be pinned in stack with:text-short-0.1.5@sha256:ebb77383743e214138cf9387875bc7d2665c5584b2e489fe1461240f19e7b53e,3161

Module documentation for 0.1.5

Data
- Data.Text
  - Data.Text.Short
    - Data.Text.Short.Partial
    - Data.Text.Short.Unsafe

Depends on 8 packages(full list with versions):

base, binary, bytestring, deepseq, ghc-prim, hashable, template-haskell, text

Used by 13 packages in nightly-2022-12-07(full list with versions):

aeson, aeson-optics, base16, base64, byteslice, cassava, core-program, core-text, dhall, lens-aeson, primitive-unlifted, quickcheck-instances, text-show-instances

This package provides the ShortText type which is suitable for keeping many short strings in memory. This is similiar to how ShortByteString relates to ByteString.

The main difference between Text and ShortText is that ShortText uses UTF-8 instead of UTF-16 internally and also doesn't support zero-copy slicing (thereby saving 2 words). Consequently, the memory footprint of a (boxed) ShortText value is 4 words (2 words when unboxed) plus the length of the UTF-8 encoded payload.

Changes

0.1.5

text-2.0 support

0.1.4

Fix fromString for single character strings. https://github.com/haskell-hvr/text-short/issues/20
Add Template Haskell Lift ShortText instance.

0.1.3

Add Data ShortText instance
Define Typeable ShortText also for GHC 7.8 as well (NB: for GHC 7.10.3 and up Typeable instances are automatically defined even when not mentioned explicitly in a deriving clause)
Add equivalent verb Data.Text.split to Data.Text.Short API
```
split :: (Char -> Bool) -> ShortText -> [ShortText]
```

0.1.2

Add IsList ShortText and PrintfArg ShortText instances

Expose partial functions via new Data.Text.Short.Partial module

foldl1 :: (Char -> Char -> Char) -> ShortText -> Char
foldl1' :: (Char -> Char -> Char) -> ShortText -> Char
foldr1 :: (Char -> Char -> Char) -> ShortText -> Char
head :: ShortText -> Char
index :: ShortText -> Int -> Char
init :: ShortText -> ShortText
last :: ShortText -> Char
tail :: ShortText -> ShortText

Add several Data.Text verbs to Data.Text.Short API

(!?) :: ShortText -> Int -> Maybe Char
all :: (Char -> Bool) -> ShortText -> Bool
any :: (Char -> Bool) -> ShortText -> Bool
append :: ShortText -> ShortText -> ShortText
break :: (Char -> Bool) -> ShortText -> (ShortText, ShortText)
breakEnd :: (Char -> Bool) -> ShortText -> (ShortText, ShortText)
concat :: [ShortText] -> ShortText
cons :: Char -> ShortText -> ShortText
drop :: Int -> ShortText -> ShortText
dropAround :: (Char -> Bool) -> ShortText -> ShortText
dropEnd :: Int -> ShortText -> ShortText
dropWhile :: (Char -> Bool) -> ShortText -> ShortText
dropWhileEnd :: (Char -> Bool) -> ShortText -> ShortText
empty :: ShortText
filter :: (Char -> Bool) -> ShortText -> ShortText
find :: (Char -> Bool) -> ShortText -> Maybe Char
findIndex :: (Char -> Bool) -> ShortText -> Maybe Int
foldl :: (a -> Char -> a) -> a -> ShortText -> a
foldl' :: (a -> Char -> a) -> a -> ShortText -> a
foldr :: (Char -> a -> a) -> a -> ShortText -> a
indexEndMaybe :: ShortText -> Int -> Maybe Char
indexMaybe :: ShortText -> Int -> Maybe Char
intercalate :: ShortText -> [ShortText] -> ShortText
intersperse :: Char -> ShortText -> ShortText
isPrefixOf :: ShortText -> ShortText -> Bool
isSuffixOf :: ShortText -> ShortText -> Bool
pack :: [Char] -> ShortText
replicate :: Int -> ShortText -> ShortText
reverse :: ShortText -> ShortText
singleton :: Char -> ShortText
snoc :: ShortText -> Char -> ShortText
span :: (Char -> Bool) -> ShortText -> (ShortText, ShortText)
spanEnd :: (Char -> Bool) -> ShortText -> (ShortText, ShortText)
splitAt :: Int -> ShortText -> (ShortText, ShortText)
splitAtEnd :: Int -> ShortText -> (ShortText, ShortText)
stripPrefix :: ShortText -> ShortText -> Maybe ShortText
stripSuffix :: ShortText -> ShortText -> Maybe ShortText
take :: Int -> ShortText -> ShortText
takeEnd :: Int -> ShortText -> ShortText
takeWhile :: (Char -> Bool) -> ShortText -> ShortText
takeWhileEnd :: (Char -> Bool) -> ShortText -> ShortText
uncons :: ShortText -> Maybe (Char, ShortText)
unpack :: ShortText -> [Char]
unsnoc :: ShortText -> Maybe (ShortText, Char)

Optimise low-level primitives
Add support for GHC 8.4

0.1.1

Expose unsafe conversion API via Data.Text.Short.Unsafe module
Minor documentation improvement

0.1

First version. Released on an unsuspecting world.