Schemas.Internal

Documentation

data TypedSchemaFlex from a where

TypedSchemaFlex enc dec is a schema for encoding to enc and decoding to dec. Usually we want enc and dec to be the same type but this flexibility comes in handy when composing typed schemas.

Constructors

TEnum :: NonEmpty (Text, a) -> (from -> Text) -> TypedSchemaFlex from a

TArray :: TypedSchema b -> (Vector b -> a) -> (from -> Vector b) -> TypedSchemaFlex from a

TMap :: TypedSchema b -> (HashMap Text b -> a) -> (from -> HashMap Text b) -> TypedSchemaFlex from a

TAllOf :: NonEmpty (TypedSchemaFlex from a) -> TypedSchemaFlex from a

Encoding and decoding support all alternatives

TOneOf :: NonEmpty (TypedSchemaFlex from a) -> TypedSchemaFlex from a

Decoding from all alternatives, but encoding only to one

TEmpty :: a -> TypedSchemaFlex from a

TPrim :: Text -> (Value -> Result a) -> (from -> Value) -> TypedSchemaFlex from a

TTry :: TypedSchemaFlex a b -> (a' -> Maybe a) -> TypedSchemaFlex a' b

RecordSchema :: RecordFields from a -> TypedSchemaFlex from a

Instances

Profunctor TypedSchemaFlex

Defined in Schemas.Internal

Methods

dimap :: (a -> b) -> (c -> d) -> TypedSchemaFlex b c -> TypedSchemaFlex a d

lmap :: (a -> b) -> TypedSchemaFlex b c -> TypedSchemaFlex a c

rmap :: (b -> c) -> TypedSchemaFlex a b -> TypedSchemaFlex a c

(#.) :: Coercible c b => q b c -> TypedSchemaFlex a b -> TypedSchemaFlex a c

(.#) :: Coercible b a => TypedSchemaFlex b c -> q a b -> TypedSchemaFlex a c

Functor (TypedSchemaFlex from)

Defined in Schemas.Internal

Methods

fmap :: (a -> b) -> TypedSchemaFlex from a -> TypedSchemaFlex from b

(<$) :: a -> TypedSchemaFlex from b -> TypedSchemaFlex from a

Semigroup a => Semigroup (TypedSchemaFlex f a)

Defined in Schemas.Internal

Methods

(<>) :: TypedSchemaFlex f a -> TypedSchemaFlex f a -> TypedSchemaFlex f a

sconcat :: NonEmpty (TypedSchemaFlex f a) -> TypedSchemaFlex f a

stimes :: Integral b => b -> TypedSchemaFlex f a -> TypedSchemaFlex f a

Monoid a => Monoid (TypedSchemaFlex f a)

Defined in Schemas.Internal

Methods

mempty :: TypedSchemaFlex f a

mappend :: TypedSchemaFlex f a -> TypedSchemaFlex f a -> TypedSchemaFlex f a

mconcat :: [TypedSchemaFlex f a] -> TypedSchemaFlex f a

enum :: Eq a => (a -> Text) -> NonEmpty a -> TypedSchema a

stringMap :: TypedSchema a -> TypedSchema (HashMap Text a)

list :: IsList l => TypedSchema (Item l) -> TypedSchema l

vector :: TypedSchema a -> TypedSchema (Vector a)

viaJSON :: (FromJSON a, ToJSON a) => Text -> TypedSchema a

viaIso :: Iso' a b -> TypedSchema a -> TypedSchema b

string :: TypedSchema String

readShow :: (Read a, Show a) => TypedSchema a

type TypedSchema a = TypedSchemaFlex a a

data RecordField from a where

Constructors

RequiredAp

Fields

• :: { fieldName :: Text
•    , fieldTypedSchema :: TypedSchemaFlex from a
•    } -> RecordField from a

OptionalAp

Fields

• :: { fieldName :: Text
•    , fieldTypedSchema :: TypedSchemaFlex from a
•    , fieldDefValue :: a
•    } -> RecordField from a

Instances

Profunctor RecordField

Defined in Schemas.Internal

Methods

dimap :: (a -> b) -> (c -> d) -> RecordField b c -> RecordField a d

lmap :: (a -> b) -> RecordField b c -> RecordField a c

rmap :: (b -> c) -> RecordField a b -> RecordField a c

(#.) :: Coercible c b => q b c -> RecordField a b -> RecordField a c

(.#) :: Coercible b a => RecordField b c -> q a b -> RecordField a c

fieldNameL :: Lens' (RecordField from a) Text

newtype RecordFields from a

Constructors

RecordFields

Fields

• getRecordFields :: Alt (RecordField from) a

Instances

Profunctor RecordFields

Defined in Schemas.Internal

Methods

dimap :: (a -> b) -> (c -> d) -> RecordFields b c -> RecordFields a d

lmap :: (a -> b) -> RecordFields b c -> RecordFields a c

rmap :: (b -> c) -> RecordFields a b -> RecordFields a c

(#.) :: Coercible c b => q b c -> RecordFields a b -> RecordFields a c

(.#) :: Coercible b a => RecordFields b c -> q a b -> RecordFields a c

Functor (RecordFields from)

Defined in Schemas.Internal

Methods

fmap :: (a -> b) -> RecordFields from a -> RecordFields from b

(<$) :: a -> RecordFields from b -> RecordFields from a

Applicative (RecordFields from)

Defined in Schemas.Internal

Methods

pure :: a -> RecordFields from a

(<*>) :: RecordFields from (a -> b) -> RecordFields from a -> RecordFields from b

liftA2 :: (a -> b -> c) -> RecordFields from a -> RecordFields from b -> RecordFields from c

(*>) :: RecordFields from a -> RecordFields from b -> RecordFields from b

(<*) :: RecordFields from a -> RecordFields from b -> RecordFields from a

Alternative (RecordFields from)

Defined in Schemas.Internal

Methods

empty :: RecordFields from a

(<|>) :: RecordFields from a -> RecordFields from a -> RecordFields from a

some :: RecordFields from a -> RecordFields from [a]

many :: RecordFields from a -> RecordFields from [a]

Semigroup (RecordFields from a)

Defined in Schemas.Internal

Methods

(<>) :: RecordFields from a -> RecordFields from a -> RecordFields from a

sconcat :: NonEmpty (RecordFields from a) -> RecordFields from a

stimes :: Integral b => b -> RecordFields from a -> RecordFields from a

Monoid (RecordFields from a)

Defined in Schemas.Internal

Methods

mempty :: RecordFields from a

mappend :: RecordFields from a -> RecordFields from a -> RecordFields from a

mconcat :: [RecordFields from a] -> RecordFields from a

overFieldNames :: (Text -> Text) -> RecordFields from a -> RecordFields from a

record :: RecordFields from a -> TypedSchemaFlex from a

Define a record schema using applicative syntax

fieldWith :: TypedSchema a -> Text -> (from -> a) -> RecordFields from a

fieldWith' :: TypedSchemaFlex from a -> Text -> RecordFields from a

data TryFailed

Constructors

TryFailed

Instances

Show TryFailed

Defined in Schemas.Internal

Methods

showsPrec :: Int -> TryFailed -> ShowS

show :: TryFailed -> String

showList :: [TryFailed] -> ShowS

Exception TryFailed

Defined in Schemas.Internal

Methods

toException :: TryFailed -> SomeException

fromException :: SomeException -> Maybe TryFailed

displayException :: TryFailed -> String

liftPrism :: Prism s t a b -> TypedSchemaFlex a b -> TypedSchemaFlex s t

Project a schema through a Prism. The resulting schema is empty if the Prism doesn't fit

liftMaybe :: TypedSchemaFlex a b -> TypedSchemaFlex (Maybe a) (Maybe b)

Use this to build schemas for optFieldWith. The resulting schema is empty for the Nothing case

liftEither :: TypedSchemaFlex a b -> TypedSchemaFlex (Either c a) (Either c b)

Use this to build schemas for optFieldEitherWith. The resulting schema is empty for the Left case

optFieldWith :: forall a from. TypedSchemaFlex from (Maybe a) -> Text -> RecordFields from (Maybe a)

A generalized version of optField. Does not handle infinite/circular data.

optFieldGeneral :: forall a from. TypedSchemaFlex from a -> Text -> a -> RecordFields from a

optFieldEitherWith :: TypedSchemaFlex from (Either e a) -> Text -> e -> RecordFields from (Either e a)

A generalized version of optFieldEither. Does not handle infinite/circular data

extractFields :: RecordFields from a -> [[(Text, Field)]]

Extract all the field groups (from alternatives) in the record

extractFieldsHelper :: (forall a. RecordField from a -> b) -> RecordFields from a -> [[b]]

union :: NonEmpty (Text, TypedSchema a) -> TypedSchema a

data UnionTag from where

Constructors

UnionTag :: Text -> Prism' from b -> TypedSchema b -> UnionTag from

altWith :: TypedSchema a -> Text -> Prism' from a -> UnionTag from

union' :: NonEmpty (UnionTag from) -> TypedSchema from

extractSchema :: TypedSchemaFlex from a -> Schema

Extract an untyped schema that can be serialized

extractValidators :: TypedSchemaFlex from a -> Validators

Returns all the primitive validators embedded in this typed schema

encodeWith :: TypedSchemaFlex from a -> from -> Value

Given a value and its typed schema, produce a JSON record using the RecordFields

encodeToWith :: TypedSchema a -> Schema -> Maybe (a -> Value)

data DecodeError

Constructors

VE Mismatch

TriedAndFailed

Instances

Eq DecodeError

Defined in Schemas.Internal

Methods

(==) :: DecodeError -> DecodeError -> Bool

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

Show DecodeError

Defined in Schemas.Internal

Methods

showsPrec :: Int -> DecodeError -> ShowS

show :: DecodeError -> String

showList :: [DecodeError] -> ShowS

runSchema :: TypedSchemaFlex enc dec -> enc -> Either [DecodeError] dec

Runs a schema as a function enc -> dec. Loops for infinite/circular data

decodeWith :: TypedSchemaFlex from a -> Value -> Either [(Trace, DecodeError)] a

Given a JSON Value and a typed schema, extract a Haskell value

decodeFromWith :: TypedSchema a -> Schema -> Maybe (Value -> Either [(Trace, DecodeError)] a)

runAlt_ :: (Alternative g, Monoid m) => (forall a. f a -> g m) -> Alt f b -> g m

(<.>) :: Functor f => (b -> c) -> (a -> f b) -> a -> f c infixr 9