Data.Preview

Documentation

class Preview a where

Conversion of values to short readable strings. Preview allows defining short and readable representations of potentially huge data structures that can be used in logs for example. E.g. the Preview instance for lists may only print the values at the beginning of the list and omit the rest.

Minimal complete definition

previewsPrec

Methods

previewsPrec :: Int -> a -> String -> String

Create a preview String for the given value.

previewsPrec should satisfy the law

previewsPrec d x r ++ s == previewsPrec d x (r ++ s)

Instances

Preview Bool

Methods

previewsPrec :: Int -> Bool -> String -> String

Preview Char

Methods

previewsPrec :: Int -> Char -> String -> String

Preview Int

Methods

previewsPrec :: Int -> Int -> String -> String

Preview Int32

Methods

previewsPrec :: Int -> Int32 -> String -> String

Preview Int64

Methods

previewsPrec :: Int -> Int64 -> String -> String

Preview Word8

Methods

previewsPrec :: Int -> Word8 -> String -> String

Preview Word64

Methods

previewsPrec :: Int -> Word64 -> String -> String

Preview ()

Methods

previewsPrec :: Int -> () -> String -> String

Preview Text

Methods

previewsPrec :: Int -> Text -> String -> String

Preview a => Preview [a]

Methods

previewsPrec :: Int -> [a] -> String -> String

Preview a => Preview (Maybe a)

Methods

previewsPrec :: Int -> Maybe a -> String -> String

Preview a => Preview (Option a)

Methods

previewsPrec :: Int -> Option a -> String -> String

Preview a => Preview (Fail a)

Methods

previewsPrec :: Int -> Fail a -> String -> String

Preview a => Preview (StrictList a)

Methods

previewsPrec :: Int -> StrictList a -> String -> String

(Preview a, Preview b) => Preview (Either a b)

Methods

previewsPrec :: Int -> Either a b -> String -> String

(Preview a, Preview b) => Preview (a, b)

Methods

previewsPrec :: Int -> (a, b) -> String -> String

(Preview k, Preview v) => Preview (Map k v)

Methods

previewsPrec :: Int -> Map k v -> String -> String

(Preview a, Preview b) => Preview (Pair a b)

Methods

previewsPrec :: Int -> Pair a b -> String -> String

(Preview a, Preview b) => Preview (Choice a b)

Methods

previewsPrec :: Int -> Choice a b -> String -> String

(Preview k, Preview v) => Preview (OSMap k v)

Methods

previewsPrec :: Int -> OSMap k v -> String -> String

(Preview a, Preview b, Preview c) => Preview (a, b, c)

Methods

previewsPrec :: Int -> (a, b, c) -> String -> String

preview :: Preview a => a -> String

previewNamedSet :: String -> t -> Set a -> String -> String

previewNamedList :: String -> t -> [a] -> String -> String

previewList :: Preview a => Int -> [a] -> String -> String

previews :: Preview a => a -> String -> String

previewRec :: Int -> String -> [(String, Int -> String -> String)] -> String -> String

previewRec' :: Int -> String -> [String -> String] -> String -> String

previewKv :: Preview a => String -> a -> String -> String

showKv :: Show a => String -> a -> String -> String

previewElems :: (Foldable t, Preview a) => t a -> String

previewsElems :: (Foldable f, Preview a) => Int -> f a -> String -> String

pprMapping :: (Ppr a, Ppr b) => [(a, b)] -> Doc

previewList' :: Preview a => Maybe Int -> Int -> [a] -> String -> String

previewsPrecMapping :: (Preview k, Preview v) => t -> [(k, v)] -> String -> String

class Ppr a where

Minimal complete definition

ppr

Methods

ppr :: a -> Doc

pprMany :: Foldable f => f a -> Doc

Instances

Ppr Bool

Methods

ppr :: Bool -> Doc

pprMany :: Foldable f => f Bool -> Doc

Ppr Char

Methods

ppr :: Char -> Doc

pprMany :: Foldable f => f Char -> Doc

Ppr Double

Methods

ppr :: Double -> Doc

pprMany :: Foldable f => f Double -> Doc

Ppr Int

Methods

ppr :: Int -> Doc

pprMany :: Foldable f => f Int -> Doc

Ppr Int32

Methods

ppr :: Int32 -> Doc

pprMany :: Foldable f => f Int32 -> Doc

Ppr Int64

Methods

ppr :: Int64 -> Doc

pprMany :: Foldable f => f Int64 -> Doc

Ppr Integer

Methods

ppr :: Integer -> Doc

pprMany :: Foldable f => f Integer -> Doc

Ppr Word8

Methods

ppr :: Word8 -> Doc

pprMany :: Foldable f => f Word8 -> Doc

Ppr Word64

Methods

ppr :: Word64 -> Doc

pprMany :: Foldable f => f Word64 -> Doc

Ppr ()

Methods

ppr :: () -> Doc

pprMany :: Foldable f => f () -> Doc

Ppr Text

Methods

ppr :: Text -> Doc

pprMany :: Foldable f => f Text -> Doc

Ppr Doc

Methods

ppr :: Doc -> Doc

pprMany :: Foldable f => f Doc -> Doc

Ppr a => Ppr [a]

Methods

ppr :: [a] -> Doc

pprMany :: Foldable f => f [a] -> Doc

Ppr a => Ppr (Maybe a)

Methods

ppr :: Maybe a -> Doc

pprMany :: Foldable f => f (Maybe a) -> Doc

Ppr a => Ppr (Set a)

Methods

ppr :: Set a -> Doc

pprMany :: Foldable f => f (Set a) -> Doc

Ppr a => Ppr (Option a)

Methods

ppr :: Option a -> Doc

pprMany :: Foldable f => f (Option a) -> Doc

Ppr a => Ppr (Fail a)

Methods

ppr :: Fail a -> Doc

pprMany :: Foldable f => f (Fail a) -> Doc

Ppr a => Ppr (StrictList a)

Methods

ppr :: StrictList a -> Doc

pprMany :: Foldable f => f (StrictList a) -> Doc

(Ppr a, Ppr b) => Ppr (a, b)

Methods

ppr :: (a, b) -> Doc

pprMany :: Foldable f => f (a, b) -> Doc

(Ppr a, Ppr b) => Ppr (Map a b)

Methods

ppr :: Map a b -> Doc

pprMany :: Foldable f => f (Map a b) -> Doc

(Ppr a, Ppr b) => Ppr (Pair a b)

Methods

ppr :: Pair a b -> Doc

pprMany :: Foldable f => f (Pair a b) -> Doc

(Ppr a, Ppr b) => Ppr (Choice a b)

Methods

ppr :: Choice a b -> Doc

pprMany :: Foldable f => f (Choice a b) -> Doc

(Ppr k, Ppr v) => Ppr (OSMap k v)

Methods

ppr :: OSMap k v -> Doc

pprMany :: Foldable f => f (OSMap k v) -> Doc

(Ppr k, Ppr v) => Ppr (USMap k v)

Methods

ppr :: USMap k v -> Doc

pprMany :: Foldable f => f (USMap k v) -> Doc

class Ppr' k where

Minimal complete definition

ppr'

Methods

ppr' :: Ppr a => k a -> Doc

data Doc :: *

The abstract type of documents. A Doc represents a set of layouts. A Doc with no occurrences of Union or NoDoc represents just one layout.

Instances

Eq Doc

Methods

(==) :: Doc -> Doc -> Bool

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

Show Doc

Methods

showsPrec :: Int -> Doc -> ShowS

show :: Doc -> String

showList :: [Doc] -> ShowS

IsString Doc

Methods

fromString :: String -> Doc

Generic Doc

Associated Types

type Rep Doc :: * -> *

Methods

from :: Doc -> Rep Doc x

to :: Rep Doc x -> Doc

Semigroup Doc

Methods

(<>) :: Doc -> Doc -> Doc

sconcat :: NonEmpty Doc -> Doc

stimes :: Integral b => b -> Doc -> Doc

Monoid Doc

Methods

mempty :: Doc

mappend :: Doc -> Doc -> Doc

mconcat :: [Doc] -> Doc

NFData Doc

Methods

rnf :: Doc -> ()

Ppr Doc

Methods

ppr :: Doc -> Doc

pprMany :: Foldable f => f Doc -> Doc

type Rep Doc

type Rep Doc = D1 (MetaData "Doc" "Text.PrettyPrint.HughesPJ" "pretty-1.1.3.3" True) (C1 (MetaCons "Doc" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Doc ()))))

pretty :: Ppr a => a -> String

prettyText :: Ppr a => a -> Text

docFromStr :: String -> Doc

shortPreviewStr :: Int -> String -> String

docFromText :: Text -> Doc

angles :: Doc -> Doc