Schemas.Class

Documentation

class HasSchema a where

Methods

schema :: TypedSchema a

Instances

HasSchema Bool

Defined in Schemas.Class

Methods

schema :: TypedSchema Bool

HasSchema Double

Defined in Schemas.Class

Methods

schema :: TypedSchema Double

HasSchema Int

Defined in Schemas.Class

Methods

schema :: TypedSchema Int

HasSchema Integer

Defined in Schemas.Class

Methods

schema :: TypedSchema Integer

HasSchema Natural

Defined in Schemas.Class

Methods

schema :: TypedSchema Natural

HasSchema ()

Defined in Schemas.Class

Methods

schema :: TypedSchema ()

HasSchema Scientific

Defined in Schemas.Class

Methods

schema :: TypedSchema Scientific

HasSchema Text

Defined in Schemas.Class

Methods

schema :: TypedSchema Text

HasSchema Value

Defined in Schemas.Class

Methods

schema :: TypedSchema Value

HasSchema String

Defined in Schemas.Class

Methods

schema :: TypedSchema String

HasSchema Field

Defined in Schemas.Class

Methods

schema :: TypedSchema Field

HasSchema Schema

Defined in Schemas.Class

Methods

schema :: TypedSchema Schema

HasSchema OpenApi2Type

Defined in Schemas.OpenApi2

Methods

schema :: TypedSchema OpenApi2Type

HasSchema OpenApi2Schema

Defined in Schemas.OpenApi2

Methods

schema :: TypedSchema OpenApi2Schema

HasSchema OpenApi2Document

Defined in Schemas.OpenApi2

Methods

schema :: TypedSchema OpenApi2Document

HasSchema a => HasSchema [a]

Defined in Schemas.Class

Methods

schema :: TypedSchema [a]

HasSchema a => HasSchema (Identity a)

Defined in Schemas.Class

Methods

schema :: TypedSchema (Identity a)

HasSchema a => HasSchema (NonEmpty a)

Defined in Schemas.Class

Methods

schema :: TypedSchema (NonEmpty a)

(Eq a, Hashable a, HasSchema a) => HasSchema (HashSet a)

Defined in Schemas.Class

Methods

schema :: TypedSchema (HashSet a)

HasSchema a => HasSchema (Vector a)

Defined in Schemas.Class

Methods

schema :: TypedSchema (Vector a)

(HasSchema a, HasSchema b) => HasSchema (Either a b)

Defined in Schemas.Class

Methods

schema :: TypedSchema (Either a b)

(HasSchema a, HasSchema b) => HasSchema (a, b)

Defined in Schemas.Class

Methods

schema :: TypedSchema (a, b)

(Eq key, Hashable key, HasSchema a, Key key) => HasSchema (HashMap key a)

Defined in Schemas.Class

Methods

schema :: TypedSchema (HashMap key a)

(HasSchema a, HasSchema b, HasSchema c) => HasSchema (a, b, c)

Defined in Schemas.Class

Methods

schema :: TypedSchema (a, b, c)

(HasSchema a, HasSchema b, HasSchema c, HasSchema d) => HasSchema (a, b, c, d)

Defined in Schemas.Class

Methods

schema :: TypedSchema (a, b, c, d)

(HasSchema a, HasSchema b, HasSchema c, HasSchema d, HasSchema e) => HasSchema (a, b, c, d, e)

Defined in Schemas.Class

Methods

schema :: TypedSchema (a, b, c, d, e)

class Key a where

Methods

fromKey :: Text -> a

toKey :: a -> Text

Instances

Key Text

Defined in Schemas.Class

Methods

fromKey :: Text -> Text

toKey :: Text -> Text

Key String

Defined in Schemas.Class

Methods

fromKey :: Text -> String

toKey :: String -> Text

theSchema :: forall a. HasSchema a => Schema

Extract the default Schema for a type

validatorsFor :: forall a. HasSchema a => Validators

encode :: HasSchema a => a -> Value

encode using the default schema

encodeTo :: HasSchema a => Schema -> Maybe (a -> Value)

Attempt to encode to the target schema using the default schema. First encodes using the default schema, then computes a coercion applying isSubtypeOf, and then applies the coercion to the encoded data.

finiteEncode :: forall a. HasSchema a => Natural -> a -> Value

Encode a value into a finite representation by enforcing a max depth

decode :: HasSchema a => Value -> Either [(Trace, DecodeError)] a

Decode using the default schema.

decodeFrom :: HasSchema a => Schema -> Maybe (Value -> Either [(Trace, DecodeError)] a)

Apply isSubtypeOf to construct a coercion from the source schema to the default schema, apply the coercion to the data, and attempt to decode using the default schema.

coerce :: forall sub sup. (HasSchema sub, HasSchema sup) => Value -> Maybe Value

Coerce from sub to supReturns Nothing if sub is not a subtype of sup

field :: HasSchema a => Text -> (from -> a) -> RecordFields from a

field name get introduces a field with the default schema for the type

optField :: forall a from. HasSchema a => Text -> (from -> Maybe a) -> RecordFields from (Maybe a)

optField name get introduces an optional field with the default schema for the type

optFieldEither :: forall a from e. HasSchema a => Text -> (from -> Either e a) -> e -> RecordFields from (Either e a)

optFieldEither name get introduces an optional field with the default schema for the type

alt :: HasSchema a => Text -> Prism' from a -> UnionTag from

alt name prism introduces a discriminated union alternative with the default schema