Data.Text.Prettyprint.Doc.Render.Vty

Documentation

render :: Doc Attr -> Image

Render a document as a VTY image using defaultLayoutOptions.

Throws: VtyDocError

renderSDS :: SimpleDocStream Attr -> Image

Render a document stream as a VTY image.

Throws: VtyDocError

data VtyDocError

Errors that can occur due to bugs in the layout logic

Constructors

VtyDocFail

SimpleDocStream contained SFail

VtyDocBadAnn

SimpleDocStream had too many SAnnPop

Instances

Eq VtyDocError

Methods

(==) :: VtyDocError -> VtyDocError -> Bool

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

Ord VtyDocError

Methods

compare :: VtyDocError -> VtyDocError -> Ordering

(<) :: VtyDocError -> VtyDocError -> Bool

(<=) :: VtyDocError -> VtyDocError -> Bool

(>) :: VtyDocError -> VtyDocError -> Bool

(>=) :: VtyDocError -> VtyDocError -> Bool

max :: VtyDocError -> VtyDocError -> VtyDocError

min :: VtyDocError -> VtyDocError -> VtyDocError

Read VtyDocError

Methods

readsPrec :: Int -> ReadS VtyDocError

readList :: ReadS [VtyDocError]

readPrec :: ReadPrec VtyDocError

readListPrec :: ReadPrec [VtyDocError]

Show VtyDocError

Methods

showsPrec :: Int -> VtyDocError -> ShowS

show :: VtyDocError -> String

showList :: [VtyDocError] -> ShowS

Exception VtyDocError

displayException provides human readable description.

Methods

toException :: VtyDocError -> SomeException

fromException :: SomeException -> Maybe VtyDocError

displayException :: VtyDocError -> String