Moduleoptics-extra-0.4.2.1Haskell2010

Data.Text.Optics

This module provides Isos for converting strict or lazy Text to or from a String or Builder, and an IxTraversal for traversing the individual characters of a Text.

The same combinators support both strict and lazy text using the IsText typeclass. You can import Data.Text.Strict.Optics or Data.Text.Lazy.Optics instead if you prefer monomorphic versions.

1 class
2 values

Packageoptics-extra-0.4.2.1
Exports4
LanguageHaskell2010
LicenceBSD-3-Clause
SourceOptics.hs

classclass IsText t where

Traversals for strict or lazy Text

Methods

packed :: Iso' String t

This isomorphism can be used to pack (or unpack) strict or lazy Text.

pack x ≡ x ^. packed
unpack x ≡ x ^. re packed
packed ≡ re unpacked

builder :: Iso' t Builder
Convert between strict or lazy Text and a Builder.
```
fromText x ≡ x ^. builder
```
text :: IxTraversal' Int t Char
Traverse the individual characters in strict or lazy Text.
```
text = unpacked . traversed
```

Instances3IsText

IsText StringDefined in optics-extra-0.4.2.1 · Data.Text.Optics
IsText TextDefined in optics-extra-0.4.2.1 · Data.Text.Optics
IsText TextDefined in optics-extra-0.4.2.1 · Data.Text.Optics

valueunpacked :: IsText t => Iso' t String

This isomorphism can be used to unpack (or pack) both strict or lazy Text.

unpack x ≡ x ^. unpacked
pack x ≡ x ^. re unpacked

This Iso is provided for notational convenience rather than out of great need, since

unpacked ≡ re packed

value_Text :: IsText t => Iso' t String

This is an alias for unpacked that makes it clearer how to use it with (#).

_Text = re packed

Example1 expression

>>> _Text # "hello" :: Strict.Text"hello"

patternpattern Text :: IsText t => String -> t