optics-extra-0.2: Extra utilities and instances for optics-core

Safe HaskellNone



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

If you need to work with both strict and lazy text, Data.Text.Optics provides combinators that support both varieties using a typeclass.



packed :: Iso' String Text Source #

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

>>> "hello" ^. packed -- :: Text
pack x ≡ x ^. packed
unpack x ≡ x ^. re packed
packedre unpacked

unpacked :: Iso' Text String Source #

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

>>> Text.pack "hello" ^. unpacked -- :: String
pack x ≡ x ^. re unpacked
unpack x ≡ x ^. packed

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

unpackedre packed

_Text :: Iso' Text String Source #

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

_Text = re packed
>>> _Text # "hello" -- :: Text

text :: IxTraversal' Int Text Char Source #

Traverse the individual characters in a Text.

>>> anyOf text (=='c') $ Text.pack "chello"
text = unpacked % traversed

When the type is unambiguous, you can also use the more general each.


Note that when just using this as a Setter, sets map can be more efficient.

builder :: Iso' Text Builder Source #

Convert between lazy Text and Builder .

fromLazyText x ≡ x ^. builder
toLazyText x ≡ x ^. re builder

utf8 :: Prism' ByteString Text Source #

Encode/Decode a lazy Text to/from lazy ByteString, via UTF-8.

Note: This function does not decode lazily, as it must consume the entire input before deciding whether or not it fails.

>>> ByteString.unpack (utf8 # Text.pack "☃")

pattern Text :: String -> Text Source #