Text.Foldable

Many of the common things we want to do with String like structures are just properties of MonoFoldable. This module provides a classes for MonoFoldables that contain Char as Stringlike structures.

The motivation here is to have re-usable functions abstracted over common things we get from Foldable. The reason we can't just use the mono-traversable package, is that it's ByteString instances are MonoFoldables containing Word8, an the goal here is to normalize the API around Char.

For example:

  isFiveChars :: FoldableString s => s -> Bool
  isFiveChars s = length s == 5

Which will work with all 5 string types

The motivation here is to have re-usable functions abstracted over common things we get from Foldable.

For example:

  isFiveChars :: FoldableString s => s -> Bool
  isFiveChars s = length s == 5

Which will work with all 5 string types. .

Documentation

module Data.MonoTraversable

class FunctorString s where

MonoFunctor containing Char

Methods

map :: (Char -> Char) -> s -> s

map :: (MonoFunctor s, Element s ~ Char) => (Char -> Char) -> s -> s

Instances

FunctorString String

Methods

map :: (Char -> Char) -> String -> String

FunctorString ByteString

Methods

map :: (Char -> Char) -> ByteString -> ByteString

FunctorString ByteString

Methods

map :: (Char -> Char) -> ByteString -> ByteString

FunctorString Text

Methods

map :: (Char -> Char) -> Text -> Text

FunctorString Text

Methods

map :: (Char -> Char) -> Text -> Text

class FoldableString s where

MonoFoldable containing Char

Methods

foldMap :: (Char -> s) -> s -> s

foldMap :: (MonoFoldable s, Element s ~ Char, Monoid s) => (Char -> s) -> s -> s

foldr :: (Char -> a -> a) -> a -> s -> a

foldr :: (MonoFoldable s, Element s ~ Char) => (Char -> a -> a) -> a -> s -> a

foldl' :: (a -> Char -> a) -> a -> s -> a

foldl' :: (MonoFoldable s, Element s ~ Char) => (a -> Char -> a) -> a -> s -> a

all :: (Char -> Bool) -> s -> Bool

all :: (MonoFoldable s, Element s ~ Char) => (Char -> Bool) -> s -> Bool

any :: (Char -> Bool) -> s -> Bool

any :: (MonoFoldable s, Element s ~ Char) => (Char -> Bool) -> s -> Bool

null :: s -> Bool

null :: MonoFoldable s => s -> Bool

length :: s -> Int

length :: MonoFoldable s => s -> Int

elem :: Char -> s -> Bool

elem :: (MonoFoldable s, Element s ~ Char) => Char -> s -> Bool

maximum :: s -> Char

maximum :: (MonoFoldable s, Element s ~ Char) => s -> Char

minimum :: s -> Char

minimum :: (MonoFoldable s, Element s ~ Char) => s -> Char

Instances

FoldableString String

Methods

foldMap :: (Char -> String) -> String -> String

foldr :: (Char -> a -> a) -> a -> String -> a

foldl' :: (a -> Char -> a) -> a -> String -> a

all :: (Char -> Bool) -> String -> Bool

any :: (Char -> Bool) -> String -> Bool

null :: String -> Bool

length :: String -> Int

elem :: Char -> String -> Bool

maximum :: String -> Char

minimum :: String -> Char

FoldableString ByteString

Methods

foldMap :: (Char -> ByteString) -> ByteString -> ByteString

foldr :: (Char -> a -> a) -> a -> ByteString -> a

foldl' :: (a -> Char -> a) -> a -> ByteString -> a

all :: (Char -> Bool) -> ByteString -> Bool

any :: (Char -> Bool) -> ByteString -> Bool

null :: ByteString -> Bool

length :: ByteString -> Int

elem :: Char -> ByteString -> Bool

maximum :: ByteString -> Char

minimum :: ByteString -> Char

FoldableString ByteString

Methods

foldMap :: (Char -> ByteString) -> ByteString -> ByteString

foldr :: (Char -> a -> a) -> a -> ByteString -> a

foldl' :: (a -> Char -> a) -> a -> ByteString -> a

all :: (Char -> Bool) -> ByteString -> Bool

any :: (Char -> Bool) -> ByteString -> Bool

null :: ByteString -> Bool

length :: ByteString -> Int

elem :: Char -> ByteString -> Bool

maximum :: ByteString -> Char

minimum :: ByteString -> Char

FoldableString Text

Methods

foldMap :: (Char -> Text) -> Text -> Text

foldr :: (Char -> a -> a) -> a -> Text -> a

foldl' :: (a -> Char -> a) -> a -> Text -> a

all :: (Char -> Bool) -> Text -> Bool

any :: (Char -> Bool) -> Text -> Bool

null :: Text -> Bool

length :: Text -> Int

elem :: Char -> Text -> Bool

maximum :: Text -> Char

minimum :: Text -> Char

FoldableString Text

Methods

foldMap :: (Char -> Text) -> Text -> Text

foldr :: (Char -> a -> a) -> a -> Text -> a

foldl' :: (a -> Char -> a) -> a -> Text -> a

all :: (Char -> Bool) -> Text -> Bool

any :: (Char -> Bool) -> Text -> Bool

null :: Text -> Bool

length :: Text -> Int

elem :: Char -> Text -> Bool

maximum :: Text -> Char

minimum :: Text -> Char

class (FunctorString s, FoldableString s) => TraverseString s where

MonoTraversable containing Char

Methods

traverse :: Applicative f => (Char -> f Char) -> s -> f s

traverse :: (MonoTraversable s, Element s ~ Char, Applicative f) => (Char -> f Char) -> s -> f s

Instances

TraverseString String

Methods

traverse :: Applicative f => (Char -> f Char) -> String -> f String

TraverseString ByteString

Methods

traverse :: Applicative f => (Char -> f Char) -> ByteString -> f ByteString

TraverseString ByteString

Methods

traverse :: Applicative f => (Char -> f Char) -> ByteString -> f ByteString

TraverseString Text

Methods

traverse :: Applicative f => (Char -> f Char) -> Text -> f Text

TraverseString Text

Methods

traverse :: Applicative f => (Char -> f Char) -> Text -> f Text