Safe Haskell	Safe-Inferred
Language	Haskell2010

Data.StringVariants.NullableNonEmptyText

Contents

Constructing
Conversion
Functions

Synopsis

newtype NullableNonEmptyText n = NullableNonEmptyText (Maybe (NonEmptyText n))
mkNonEmptyTextWithTruncate :: forall n. (KnownNat n, 1 <= n) => Text -> Maybe (NonEmptyText n)
compileNullableNonEmptyText :: Integer -> QuasiQuoter
literalNullableNonEmptyText :: forall (s :: Symbol) (n :: Nat). (KnownSymbol s, KnownNat n, SymbolNonEmpty s, SymbolWithNoSpaceAround s, SymbolNoLongerThan s n) => NullableNonEmptyText n
mkNullableNonEmptyText :: forall n. (KnownNat n, 1 <= n) => Text -> Maybe (NullableNonEmptyText n)
parseNullableNonEmptyText :: (KnownNat n, 1 <= n) => Text -> Object -> Parser (NullableNonEmptyText n)
nullNonEmptyText :: NullableNonEmptyText n
maybeTextToTruncateNullableNonEmptyText :: forall n. (KnownNat n, 1 <= n) => Maybe Text -> NullableNonEmptyText n
nonEmptyTextToNullable :: NonEmptyText n -> NullableNonEmptyText n
maybeNonEmptyTextToNullable :: Maybe (NonEmptyText n) -> NullableNonEmptyText n
nullableNonEmptyTextToMaybeText :: NullableNonEmptyText n -> Maybe Text
nullableNonEmptyTextToMaybeNonEmptyText :: NullableNonEmptyText n -> Maybe (NonEmptyText n)
fromMaybeNullableText :: Maybe (NullableNonEmptyText n) -> NullableNonEmptyText n
isNullNonEmptyText :: NullableNonEmptyText n -> Bool

Documentation

newtype NullableNonEmptyText n Source #

Newtype wrapper around Maybe NonEmptyText that converts empty string to Nothing.

This is aimed primarily at JSON parsing: make it possible to parse empty string and turn it into Nothing, in order to convert everything into Maybe NonEmptyText at the edge of the system.

While using this for JSON parsing, use Maybe NullableNonEmptyText. Aeson special-cases Maybe to allow nulls, so Maybe catches the nulls and NullableNonEmptyText catches the empty strings.

To extract Maybe NonEmptyText values from Maybe NullableNonEmptyText, use nullableNonEmptyTextToMaybeNonEmptyText.

Constructors

NullableNonEmptyText (Maybe (NonEmptyText n))

Instances

Instances details

(KnownNat n, 1 <= n) => FromJSON (NullableNonEmptyText n) Source #
Instance details Defined in Data.StringVariants.NullableNonEmptyText Methods parseJSON :: Value -> Parser (NullableNonEmptyText n) # parseJSONList :: Value -> Parser [NullableNonEmptyText n] #
ToJSON (NullableNonEmptyText n) Source #
Instance details Defined in Data.StringVariants.NullableNonEmptyText Methods toJSON :: NullableNonEmptyText n -> Value # toEncoding :: NullableNonEmptyText n -> Encoding # toJSONList :: [NullableNonEmptyText n] -> Value # toEncodingList :: [NullableNonEmptyText n] -> Encoding #
Generic (NullableNonEmptyText n) Source #
Instance details Defined in Data.StringVariants.NullableNonEmptyText Associated Types type Rep (NullableNonEmptyText n) :: Type -> Type # Methods from :: NullableNonEmptyText n -> Rep (NullableNonEmptyText n) x # to :: Rep (NullableNonEmptyText n) x -> NullableNonEmptyText n #
Read (NullableNonEmptyText n) Source #
Instance details Defined in Data.StringVariants.NullableNonEmptyText Methods readsPrec :: Int -> ReadS (NullableNonEmptyText n) # readList :: ReadS [NullableNonEmptyText n] # readPrec :: ReadPrec (NullableNonEmptyText n) # readListPrec :: ReadPrec [NullableNonEmptyText n] #
Show (NullableNonEmptyText n) Source #
Instance details Defined in Data.StringVariants.NullableNonEmptyText Methods showsPrec :: Int -> NullableNonEmptyText n -> ShowS # show :: NullableNonEmptyText n -> String # showList :: [NullableNonEmptyText n] -> ShowS #
Eq (NullableNonEmptyText n) Source #
Instance details Defined in Data.StringVariants.NullableNonEmptyText Methods (==) :: NullableNonEmptyText n -> NullableNonEmptyText n -> Bool # (/=) :: NullableNonEmptyText n -> NullableNonEmptyText n -> Bool #
Lift (NullableNonEmptyText n :: TYPE LiftedRep) Source #
Instance details Defined in Data.StringVariants.NullableNonEmptyText Methods lift :: Quote m => NullableNonEmptyText n -> m Exp # liftTyped :: forall (m :: Type -> Type). Quote m => NullableNonEmptyText n -> Code m (NullableNonEmptyText n) #
type Rep (NullableNonEmptyText n) Source #
Instance details Defined in Data.StringVariants.NullableNonEmptyText type Rep (NullableNonEmptyText n) = D1 ('MetaData "NullableNonEmptyText" "Data.StringVariants.NullableNonEmptyText" "string-variants-0.2.0.0-Ibj8xjKMcicJdCv0IWSIjz" 'True) (C1 ('MetaCons "NullableNonEmptyText" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (NonEmptyText n)))))

Constructing

mkNonEmptyTextWithTruncate :: forall n. (KnownNat n, 1 <= n) => Text -> Maybe (NonEmptyText n) Source #

compileNullableNonEmptyText :: Integer -> QuasiQuoter Source #

literalNullableNonEmptyText :: forall (s :: Symbol) (n :: Nat). (KnownSymbol s, KnownNat n, SymbolNonEmpty s, SymbolWithNoSpaceAround s, SymbolNoLongerThan s n) => NullableNonEmptyText n Source #

This requires the text to be non-empty. For the empty text just use the constructor `NullableNonEmptyText Nothing`

mkNullableNonEmptyText :: forall n. (KnownNat n, 1 <= n) => Text -> Maybe (NullableNonEmptyText n) Source #

parseNullableNonEmptyText :: (KnownNat n, 1 <= n) => Text -> Object -> Parser (NullableNonEmptyText n) Source #

nullNonEmptyText :: NullableNonEmptyText n Source #

Conversion

maybeTextToTruncateNullableNonEmptyText :: forall n. (KnownNat n, 1 <= n) => Maybe Text -> NullableNonEmptyText n Source #

nonEmptyTextToNullable :: NonEmptyText n -> NullableNonEmptyText n Source #

maybeNonEmptyTextToNullable :: Maybe (NonEmptyText n) -> NullableNonEmptyText n Source #

nullableNonEmptyTextToMaybeText :: NullableNonEmptyText n -> Maybe Text Source #

nullableNonEmptyTextToMaybeNonEmptyText :: NullableNonEmptyText n -> Maybe (NonEmptyText n) Source #

fromMaybeNullableText :: Maybe (NullableNonEmptyText n) -> NullableNonEmptyText n Source #

Functions

isNullNonEmptyText :: NullableNonEmptyText n -> Bool Source #