SuperRecord.Variant.Text

Documentation

data TextVariant (opts :: [Symbol])

A text only variant: A wrapped Text that can only be one of the given values tracked at type level. Very useful for interacting with enum-like string in JSON APIs.

Instances

Eq (TextVariant opts)

Defined in SuperRecord.Variant.Text

Methods

(==) :: TextVariant opts -> TextVariant opts -> Bool

(/=) :: TextVariant opts -> TextVariant opts -> Bool

Ord (TextVariant opts)

Defined in SuperRecord.Variant.Text

Methods

compare :: TextVariant opts -> TextVariant opts -> Ordering

(<) :: TextVariant opts -> TextVariant opts -> Bool

(<=) :: TextVariant opts -> TextVariant opts -> Bool

(>) :: TextVariant opts -> TextVariant opts -> Bool

(>=) :: TextVariant opts -> TextVariant opts -> Bool

max :: TextVariant opts -> TextVariant opts -> TextVariant opts

min :: TextVariant opts -> TextVariant opts -> TextVariant opts

Show (TextVariant opts)

Defined in SuperRecord.Variant.Text

Methods

showsPrec :: Int -> TextVariant opts -> ShowS

show :: TextVariant opts -> String

showList :: [TextVariant opts] -> ShowS

ToJSON (TextVariant opts)

Defined in SuperRecord.Variant.Text

Methods

toJSON :: TextVariant opts -> Value

toEncoding :: TextVariant opts -> Encoding

toJSONList :: [TextVariant opts] -> Value

toEncodingList :: [TextVariant opts] -> Encoding

TextVariantBuilder opts => FromJSON (TextVariant opts)

Defined in SuperRecord.Variant.Text

Methods

parseJSON :: Value -> Parser (TextVariant opts)

parseJSONList :: Value -> Parser [TextVariant opts]

NFData (TextVariant opts)

Defined in SuperRecord.Variant.Text

Methods

rnf :: TextVariant opts -> ()

type family TextVariantMember (lbl :: Symbol) (opts :: [Symbol]) where ...

Equations

TextVariantMember lbl (lbl ': xs) = True ~ True

TextVariantMember lbl (lbl1 ': ys) = TextVariantMember lbl ys

emptyTextVariant :: TextVariant '[]

An empty TextVariant, equivalent to `()`

toTextVariant :: forall opts lbl. (KnownSymbol lbl, TextVariantMember lbl opts) => FldProxy lbl -> TextVariant opts

Create a TextVariant value from a statically known string. Use OverloadedLabels for nice syntax: toTextVariant #myString

fromTextVariant :: TextVariant opts -> Text

Convert a TextVariant back to a normal Text. This operation is cheap since TextVariant is a simple newtype.

data TextVariantMatch r ts where

Constructors

TextVariantCase :: FldProxy lbl -> r -> TextVariantMatch r ts -> TextVariantMatch r (lbl ': ts)

TextVariantEnd :: TextVariantMatch r '[]

TextVariantWildCard :: r -> TextVariantMatch r ts

class TextVariantMatcher r opts where

Pattern matching helper with totality check. Note that the performance of this pattern match is roughly like a normal pattern match. (See benchmarks)

Methods

textVariantMatch :: TextVariant opts -> TextVariantMatch r opts -> r

Instances

TextVariantMatcher r ([] :: [Symbol])

Defined in SuperRecord.Variant.Text

Methods

textVariantMatch :: TextVariant [] -> TextVariantMatch r [] -> r

(KnownSymbol lbl, TextVariantMatcher r ts) => TextVariantMatcher r (lbl ': ts)

Defined in SuperRecord.Variant.Text

Methods

textVariantMatch :: TextVariant (lbl ': ts) -> TextVariantMatch r (lbl ': ts) -> r

class TextVariantBuilder opts where

Build a variant from a text that is not statically known at compile time. Returns Nothing on failure (i.E. when a value is given that is not part of the variant)

Methods

buildTextVariant :: Text -> Maybe (TextVariant opts)

Instances

TextVariantBuilder ([] :: [Symbol])

Defined in SuperRecord.Variant.Text

Methods

buildTextVariant :: Text -> Maybe (TextVariant [])

(KnownSymbol lbl, TextVariantBuilder ts) => TextVariantBuilder (lbl ': ts)

Defined in SuperRecord.Variant.Text

Methods

buildTextVariant :: Text -> Maybe (TextVariant (lbl ': ts))