Data.GraphViz.Exception

Documentation

data GraphvizException

Exceptions that arise from using this library fall into four categories:

• Unable to parse provided Dot code.
• Dot code is not valid UTF-8.
• An error when trying to run an external program (e.g. dot).
• Treating a non-custom Attribute as a custom one.

Constructors

NotDotCode String

NotUTF8Dot String

GVProgramExc String

NotCustomAttr String

Instances

Eq GraphvizException

Methods

(==) :: GraphvizException -> GraphvizException -> Bool

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

Ord GraphvizException

Methods

compare :: GraphvizException -> GraphvizException -> Ordering

(<) :: GraphvizException -> GraphvizException -> Bool

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

(>) :: GraphvizException -> GraphvizException -> Bool

(>=) :: GraphvizException -> GraphvizException -> Bool

max :: GraphvizException -> GraphvizException -> GraphvizException

min :: GraphvizException -> GraphvizException -> GraphvizException

Show GraphvizException

Methods

showsPrec :: Int -> GraphvizException -> ShowS

show :: GraphvizException -> String

showList :: [GraphvizException] -> ShowS

Exception GraphvizException

Methods

toException :: GraphvizException -> SomeException

fromException :: SomeException -> Maybe GraphvizException

displayException :: GraphvizException -> String

Re-exported for convenience.

mapException :: (Exception e1, Exception e2) => (e1 -> e2) -> a -> a

This function maps one exception into another as proposed in the paper "A semantics for imprecise exceptions".

throw :: Exception e => e -> a

Throw an exception. Exceptions may be thrown from purely functional code, but may only be caught within the IO monad.

handle :: Exception e => (e -> IO a) -> IO a -> IO a

A version of catch with the arguments swapped around; useful in situations where the code for the handler is shorter. For example:

  do handle (\NonTermination -> exitWith (ExitFailure 1)) $
     ...

bracket

Arguments

:: IO a

computation to run first ("acquire resource")

-> (a -> IO b)

computation to run last ("release resource")

-> (a -> IO c)

computation to run in-between

-> IO c

When you want to acquire a resource, do some work with it, and then release the resource, it is a good idea to use bracket, because bracket will install the necessary exception handler to release the resource in the event that an exception is raised during the computation. If an exception is raised, then bracket will re-raise the exception (after performing the release).

A common example is opening a file:

bracket
  (openFile "filename" ReadMode)
  (hClose)
  (\fileHandle -> do { ... })

The arguments to bracket are in this order so that we can partially apply it, e.g.:

withFile name mode = bracket (openFile name mode) hClose