Observe.Event.Render.JSON

Rendering types for JSON-consuming EventBackends.

Instances of RenderSelectorJSON and RenderFieldJSON can be generated by Observe.Event.Render.JSON.DSL.Compile.

Documentation

type RenderSelectorJSON sel = forall f. sel f -> (Key, RenderFieldJSON f)

A function to render a given selector, and its fields, as JSON.

The Key is the event name/category.

type RenderFieldJSON field = field -> (Key, Value)

A function to render a given field as JSON.

The Key is a field name, the Value is an arbitrary rendering of the field value (if any).

Default renderers

class DefaultRenderSelectorJSON sel where

A default RenderSelectorJSON, useful for auto-generation and simple backend invocation.

Methods

defaultRenderSelectorJSON :: RenderSelectorJSON sel

Instances

DefaultRenderSelectorJSON DynamicEventSelector

Defined in Observe.Event.Render.JSON

Methods

defaultRenderSelectorJSON :: RenderSelectorJSON DynamicEventSelector

class DefaultRenderFieldJSON field where

A default RenderFieldJSON, useful for auto-generation and simple backend invocation.

Methods

defaultRenderFieldJSON :: RenderFieldJSON field

Instances

DefaultRenderFieldJSON Void

Defined in Observe.Event.Render.JSON

Methods

defaultRenderFieldJSON :: RenderFieldJSON Void

DefaultRenderFieldJSON DynamicField

Defined in Observe.Event.Render.JSON

Methods

defaultRenderFieldJSON :: RenderFieldJSON DynamicField

Rendering structured exceptions

type RenderExJSON stex = stex -> Value

A function to render a given structured exception to JSON.

SomeJSONException

data SomeJSONException

A possible base type for structured exceptions renderable to JSON.

It is not necessary to use SomeJSONException for the base of your structured exceptions in a JSON backend, so long as you provide a RenderExJSON for your base exception type (or use ToJSON-based rendering).

Constructors

forall e.(Exception e, ToJSON e) => SomeJSONException e

Instances

ToJSON SomeJSONException

Defined in Observe.Event.Render.JSON

Methods

toJSON :: SomeJSONException -> Value

toEncoding :: SomeJSONException -> Encoding

toJSONList :: [SomeJSONException] -> Value

toEncodingList :: [SomeJSONException] -> Encoding

Exception SomeJSONException

Defined in Observe.Event.Render.JSON

Methods

toException :: SomeJSONException -> SomeException

fromException :: SomeException -> Maybe SomeJSONException

displayException :: SomeJSONException -> String

Show SomeJSONException

Defined in Observe.Event.Render.JSON

Methods

showsPrec :: Int -> SomeJSONException -> ShowS

show :: SomeJSONException -> String

showList :: [SomeJSONException] -> ShowS

jsonExceptionToException :: (Exception e, ToJSON e) => e -> SomeException

Used to create sub-classes of SomeJSONException.

jsonExceptionFromException :: Exception e => SomeException -> Maybe e

Used to create sub-classes of SomeJSONException.