Data.Text.Prettyprint.Doc.Render.GraphViz

Rendering functions

render :: Doc Attribute -> Label

Render a document as a GraphViz label, using defaultLayoutOptions.

render' :: SimpleDocStream Attribute -> Text

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

Error handling

data GraphVizRenderError

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

Defined in Data.Text.Prettyprint.Doc.Render.GraphViz

Methods

(==) :: GraphVizRenderError -> GraphVizRenderError -> Bool

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

Ord GraphVizRenderError

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

Defined in Data.Text.Prettyprint.Doc.Render.GraphViz

Methods

readsPrec :: Int -> ReadS GraphVizRenderError

readList :: ReadS [GraphVizRenderError]

readPrec :: ReadPrec GraphVizRenderError

readListPrec :: ReadPrec [GraphVizRenderError]

Show GraphVizRenderError

Defined in Data.Text.Prettyprint.Doc.Render.GraphViz

Methods

showsPrec :: Int -> GraphVizRenderError -> ShowS

show :: GraphVizRenderError -> String

showList :: [GraphVizRenderError] -> ShowS

Exception GraphVizRenderError

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

A total version of render.

renderSafe' :: SimpleDocStream Attribute -> Either GraphVizRenderError Text

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