Safe Haskell	None
Language	Haskell2010

Data.Text.Prettyprint.Doc.Render.GraphViz

Contents

Rendering functions
Error handling

Synopsis

render :: Doc Attribute -> Label
render' :: SimpleDocStream Attribute -> Text
data GraphVizRenderError
- = GVDocStreamFail
- | GVEmptyStack
renderSafe :: Doc Attribute -> Either GraphVizRenderError Label
renderSafe' :: SimpleDocStream Attribute -> Either GraphVizRenderError Text

Rendering functions

render :: Doc Attribute -> Label Source #

Render a document as a GraphViz label, using defaultLayoutOptions.

render' :: SimpleDocStream Attribute -> Text Source #

Render a document stream as HTML text for GraphViz. This provides more fine-grained control than render.

Error handling

data GraphVizRenderError Source #

The functions in this module can throw errors, given a malformed document stream. The average user is very unlikely to run into this, but error handling functionality is provided for completeness.

Constructors

GVDocStreamFail
GVEmptyStack

Instances

Eq GraphVizRenderError Source #
Instance details Defined in Data.Text.Prettyprint.Doc.Render.GraphViz Methods (==) :: GraphVizRenderError -> GraphVizRenderError -> Bool # (/=) :: GraphVizRenderError -> GraphVizRenderError -> Bool #
Ord GraphVizRenderError Source #
Instance details Defined in Data.Text.Prettyprint.Doc.Render.GraphViz Methods compare :: GraphVizRenderError -> GraphVizRenderError -> Ordering # (<) :: GraphVizRenderError -> GraphVizRenderError -> Bool # (<=) :: GraphVizRenderError -> GraphVizRenderError -> Bool # (>) :: GraphVizRenderError -> GraphVizRenderError -> Bool # (>=) :: GraphVizRenderError -> GraphVizRenderError -> Bool # max :: GraphVizRenderError -> GraphVizRenderError -> GraphVizRenderError # min :: GraphVizRenderError -> GraphVizRenderError -> GraphVizRenderError #
Read GraphVizRenderError Source #
Instance details Defined in Data.Text.Prettyprint.Doc.Render.GraphViz Methods readsPrec :: Int -> ReadS GraphVizRenderError # readList :: ReadS [GraphVizRenderError] # readPrec :: ReadPrec GraphVizRenderError # readListPrec :: ReadPrec [GraphVizRenderError] #
Show GraphVizRenderError Source #
Instance details Defined in Data.Text.Prettyprint.Doc.Render.GraphViz Methods showsPrec :: Int -> GraphVizRenderError -> ShowS # show :: GraphVizRenderError -> String # showList :: [GraphVizRenderError] -> ShowS #
Exception GraphVizRenderError Source #
Instance details Defined in Data.Text.Prettyprint.Doc.Render.GraphViz Methods toException :: GraphVizRenderError -> SomeException # fromException :: SomeException -> Maybe GraphVizRenderError # displayException :: GraphVizRenderError -> String #

renderSafe :: Doc Attribute -> Either GraphVizRenderError Label Source #

A total version of render.

renderSafe' :: SimpleDocStream Attribute -> Either GraphVizRenderError Text Source #

A total version of 'render\''. This can be seen as a generalisation of any of the other functions exported by this module.