json-api-0.1.0.4: Utilities for generating JSON-API payloads

Safe HaskellNone
LanguageHaskell2010

Network.JSONApi.Meta

Description

Module representing a JSON-API meta object.

Specification: http://jsonapi.org/format/#document-meta

Synopsis

Documentation

data Meta a Source #

Type representing a JSON-API meta object.

Meta is an abstraction around an underlying Map consisting of resource-specific metadata.

Example JSON: "meta": { "copyright": "Copyright 2015 Example Corp.", "authors": [ "Andre Dawson", "Kirby Puckett", "Don Mattingly", "Ozzie Guillen" ] }

Specification: http://jsonapi.org/format/#document-meta

Constructors

Meta (Map Text a) 

Instances

Eq a => Eq (Meta a) Source # 

Methods

(==) :: Meta a -> Meta a -> Bool #

(/=) :: Meta a -> Meta a -> Bool #

Ord a => Ord (Meta a) Source # 

Methods

compare :: Meta a -> Meta a -> Ordering #

(<) :: Meta a -> Meta a -> Bool #

(<=) :: Meta a -> Meta a -> Bool #

(>) :: Meta a -> Meta a -> Bool #

(>=) :: Meta a -> Meta a -> Bool #

max :: Meta a -> Meta a -> Meta a #

min :: Meta a -> Meta a -> Meta a #

Show a => Show (Meta a) Source # 

Methods

showsPrec :: Int -> Meta a -> ShowS #

show :: Meta a -> String #

showList :: [Meta a] -> ShowS #

Generic (Meta a) Source # 

Associated Types

type Rep (Meta a) :: * -> * #

Methods

from :: Meta a -> Rep (Meta a) x #

to :: Rep (Meta a) x -> Meta a #

ToJSON a => ToJSON (Meta a) Source # 

Methods

toJSON :: Meta a -> Value #

toEncoding :: Meta a -> Encoding #

FromJSON a => FromJSON (Meta a) Source # 

Methods

parseJSON :: Value -> Parser (Meta a) #

type Rep (Meta a) Source # 
type Rep (Meta a) = D1 (MetaData "Meta" "Network.JSONApi.Meta" "json-api-0.1.0.4-XQJNxt8UE1JTVw5IChpYb" False) (C1 (MetaCons "Meta" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Map Text a))))