Data.StringVariants

Non empty text

data NonEmptyText (n :: Nat)

Non Empty Text, requires the input is between 1 and n chars and not just whitespace.

Instances

(KnownNat n, 1 <= n) => Arbitrary (NonEmptyText n)

Defined in Data.StringVariants.NonEmptyText.Internal

Methods

arbitrary :: Gen (NonEmptyText n)

shrink :: NonEmptyText n -> [NonEmptyText n]

(KnownNat n, 1 <= n) => FromJSON (NonEmptyText n)

Defined in Data.StringVariants.NonEmptyText.Internal

Methods

parseJSON :: Value -> Parser (NonEmptyText n)

parseJSONList :: Value -> Parser [NonEmptyText n]

ToJSON (NonEmptyText n)

Defined in Data.StringVariants.NonEmptyText.Internal

Methods

toJSON :: NonEmptyText n -> Value

toEncoding :: NonEmptyText n -> Encoding

toJSONList :: [NonEmptyText n] -> Value

toEncodingList :: [NonEmptyText n] -> Encoding

Semigroup (NonEmptyText n)

Defined in Data.StringVariants.NonEmptyText.Internal

Methods

(<>) :: NonEmptyText n -> NonEmptyText n -> NonEmptyText n

sconcat :: NonEmpty (NonEmptyText n) -> NonEmptyText n

stimes :: Integral b => b -> NonEmptyText n -> NonEmptyText n

Generic (NonEmptyText n)

Defined in Data.StringVariants.NonEmptyText.Internal

Associated Types

type Rep (NonEmptyText n) :: Type -> Type

Methods

from :: NonEmptyText n -> Rep (NonEmptyText n) x

to :: Rep (NonEmptyText n) x -> NonEmptyText n

Read (NonEmptyText n)

Defined in Data.StringVariants.NonEmptyText.Internal

Methods

readsPrec :: Int -> ReadS (NonEmptyText n)

readList :: ReadS [NonEmptyText n]

readPrec :: ReadPrec (NonEmptyText n)

readListPrec :: ReadPrec [NonEmptyText n]

Show (NonEmptyText n)

Defined in Data.StringVariants.NonEmptyText.Internal

Methods

showsPrec :: Int -> NonEmptyText n -> ShowS

show :: NonEmptyText n -> String

showList :: [NonEmptyText n] -> ShowS

Eq (NonEmptyText n)

Defined in Data.StringVariants.NonEmptyText.Internal

Methods

(==) :: NonEmptyText n -> NonEmptyText n -> Bool

(/=) :: NonEmptyText n -> NonEmptyText n -> Bool

Ord (NonEmptyText n)

Defined in Data.StringVariants.NonEmptyText.Internal

Methods

compare :: NonEmptyText n -> NonEmptyText n -> Ordering

(<) :: NonEmptyText n -> NonEmptyText n -> Bool

(<=) :: NonEmptyText n -> NonEmptyText n -> Bool

(>) :: NonEmptyText n -> NonEmptyText n -> Bool

(>=) :: NonEmptyText n -> NonEmptyText n -> Bool

max :: NonEmptyText n -> NonEmptyText n -> NonEmptyText n

min :: NonEmptyText n -> NonEmptyText n -> NonEmptyText n

MonoFoldable (NonEmptyText n)

Defined in Data.StringVariants.NonEmptyText.Internal

Methods

ofoldMap :: Monoid m => (Element (NonEmptyText n) -> m) -> NonEmptyText n -> m

ofoldr :: (Element (NonEmptyText n) -> b -> b) -> b -> NonEmptyText n -> b

ofoldl' :: (a -> Element (NonEmptyText n) -> a) -> a -> NonEmptyText n -> a

otoList :: NonEmptyText n -> [Element (NonEmptyText n)]

oall :: (Element (NonEmptyText n) -> Bool) -> NonEmptyText n -> Bool

oany :: (Element (NonEmptyText n) -> Bool) -> NonEmptyText n -> Bool

onull :: NonEmptyText n -> Bool

olength :: NonEmptyText n -> Int

olength64 :: NonEmptyText n -> Int64

ocompareLength :: Integral i => NonEmptyText n -> i -> Ordering

otraverse_ :: Applicative f => (Element (NonEmptyText n) -> f b) -> NonEmptyText n -> f ()

ofor_ :: Applicative f => NonEmptyText n -> (Element (NonEmptyText n) -> f b) -> f ()

omapM_ :: Applicative m => (Element (NonEmptyText n) -> m ()) -> NonEmptyText n -> m ()

oforM_ :: Applicative m => NonEmptyText n -> (Element (NonEmptyText n) -> m ()) -> m ()

ofoldlM :: Monad m => (a -> Element (NonEmptyText n) -> m a) -> a -> NonEmptyText n -> m a

ofoldMap1Ex :: Semigroup m => (Element (NonEmptyText n) -> m) -> NonEmptyText n -> m

ofoldr1Ex :: (Element (NonEmptyText n) -> Element (NonEmptyText n) -> Element (NonEmptyText n)) -> NonEmptyText n -> Element (NonEmptyText n)

ofoldl1Ex' :: (Element (NonEmptyText n) -> Element (NonEmptyText n) -> Element (NonEmptyText n)) -> NonEmptyText n -> Element (NonEmptyText n)

headEx :: NonEmptyText n -> Element (NonEmptyText n)

lastEx :: NonEmptyText n -> Element (NonEmptyText n)

unsafeHead :: NonEmptyText n -> Element (NonEmptyText n)

unsafeLast :: NonEmptyText n -> Element (NonEmptyText n)

maximumByEx :: (Element (NonEmptyText n) -> Element (NonEmptyText n) -> Ordering) -> NonEmptyText n -> Element (NonEmptyText n)

minimumByEx :: (Element (NonEmptyText n) -> Element (NonEmptyText n) -> Ordering) -> NonEmptyText n -> Element (NonEmptyText n)

oelem :: Element (NonEmptyText n) -> NonEmptyText n -> Bool

onotElem :: Element (NonEmptyText n) -> NonEmptyText n -> Bool

ConvertibleStrings (NonEmptyText n) ByteString

Defined in Data.StringVariants.NonEmptyText.Internal

Methods

convertString :: NonEmptyText n -> ByteString

ConvertibleStrings (NonEmptyText n) Text

Defined in Data.StringVariants.NonEmptyText.Internal

Methods

convertString :: NonEmptyText n -> Text

ConvertibleStrings (NonEmptyText n) String

Defined in Data.StringVariants.NonEmptyText.Internal

Methods

convertString :: NonEmptyText n -> String

Lift (NonEmptyText n :: TYPE LiftedRep)

Defined in Data.StringVariants.NonEmptyText.Internal

Methods

lift :: Quote m => NonEmptyText n -> m Exp

liftTyped :: forall (m :: Type -> Type). Quote m => NonEmptyText n -> Code m (NonEmptyText n)

type Rep (NonEmptyText n)

Defined in Data.StringVariants.NonEmptyText.Internal

type Rep (NonEmptyText n) = D1 ('MetaData "NonEmptyText" "Data.StringVariants.NonEmptyText.Internal" "string-variants-0.2.2.0-L1nEobhilOlDqXkUm2lEef" 'True) (C1 ('MetaCons "NonEmptyText" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

type Element (NonEmptyText _n)

Defined in Data.StringVariants.NonEmptyText.Internal

type Element (NonEmptyText _n) = Char

Constructing

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

unsafeMkNonEmptyText :: forall n. (KnownNat n, 1 <= n) => Text -> NonEmptyText n

Make a NonEmptyText when you can manually verify the length

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

compileNonEmptyText :: Integer -> QuasiQuoter

compileNonEmptyTextKnownLength :: QuasiQuoter

Converting

nonEmptyTextToText :: NonEmptyText n -> Text

convertEmptyTextToNothing :: Text -> Maybe Text

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

type (<=) (x :: k) (y :: k) = (x <=? y) ~ 'True infix 4

Comparison (<=) of comparable types, as a constraint.

Since: base-4.16.0.0

widen :: (1 <= n, n <= m) => NonEmptyText n -> NonEmptyText m

Converts a NonEmptyText to a wider NonEmptyText

Operations

takeNonEmptyText :: forall m n. (KnownNat m, KnownNat n, 1 <= n, n <= m) => NonEmptyText m -> NonEmptyText n

Narrows the maximum length, dropping any remaining trailing characters.

takeNonEmptyTextEnd :: forall m n. (KnownNat m, KnownNat n, 1 <= n, n <= m) => NonEmptyText m -> NonEmptyText n

Narrows the maximum length, dropping any prefix remaining characters.

chunksOfNonEmptyText :: forall chunkSize totalSize. (KnownNat chunkSize, KnownNat totalSize, chunkSize <= totalSize, 1 <= chunkSize) => NonEmptyText totalSize -> NonEmpty (NonEmptyText chunkSize)

O(n) Splits a NonEmptyText into components of length chunkSize. The chunks may be shorter than the chunkSize depending on the length of the input and spacing. Each chunk is stripped of whitespace.

filterNonEmptyText :: (KnownNat n, 1 <= n) => (Char -> Bool) -> NonEmptyText n -> Maybe (NonEmptyText n)

Identical to the normal text filter function, but maintains the type-level invariant that the text length is <= n, unlike unwrapping the text, filtering, then rewrapping the text.

Will return Nothing if the resulting length is zero.

(<>|) :: NonEmptyText n -> NonEmptyText m -> NonEmptyText (n + m)

Concat two NonEmptyText values, with the new maximum length being the sum of the two maximum lengths of the inputs.

Mnemonic: <> for monoid, | from NonEmpty's :| operator

Conversions between Refined and NonEmptyText.

data ContainsNonWhitespaceCharacters

Constructors

ContainsNonWhitespaceCharacters

Instances

Generic ContainsNonWhitespaceCharacters

Defined in Data.StringVariants.NonEmptyText

Associated Types

type Rep ContainsNonWhitespaceCharacters :: Type -> Type

Methods

from :: ContainsNonWhitespaceCharacters -> Rep ContainsNonWhitespaceCharacters x

to :: Rep ContainsNonWhitespaceCharacters x -> ContainsNonWhitespaceCharacters

Predicate ContainsNonWhitespaceCharacters Text

Defined in Data.StringVariants.NonEmptyText

Methods

validate :: Proxy ContainsNonWhitespaceCharacters -> Text -> Maybe RefineException

type Rep ContainsNonWhitespaceCharacters

Defined in Data.StringVariants.NonEmptyText

type Rep ContainsNonWhitespaceCharacters = D1 ('MetaData "ContainsNonWhitespaceCharacters" "Data.StringVariants.NonEmptyText" "string-variants-0.2.2.0-L1nEobhilOlDqXkUm2lEef" 'False) (C1 ('MetaCons "ContainsNonWhitespaceCharacters" 'PrefixI 'False) (U1 :: Type -> Type))

exactLengthRefinedToRange :: Refined (ContainsNonWhitespaceCharacters && SizeEqualTo n) Text -> NonEmptyText n

nonEmptyTextFromRefined :: Refined (ContainsNonWhitespaceCharacters && (SizeLessThan n || SizeEqualTo n)) Text -> NonEmptyText n

refinedFromNonEmptyText :: NonEmptyText n -> Refined (ContainsNonWhitespaceCharacters && (SizeLessThan n || SizeEqualTo n)) Text

Non-empty, whitespace-trimmed text with no character limit

data Prose

Whitespace-trimmed, non-empty text, for use with API endpoints. The rationale is that there are many situations where if a client sends text that is empty or all whitespace, there's probably a client error. Not suitable for database fields, as there is no character limit (see ProsePersistFieldMsg).

Instances

FromJSON Prose

Defined in Data.StringVariants.Prose.Internal

Methods

parseJSON :: Value -> Parser Prose

parseJSONList :: Value -> Parser [Prose]

ToJSON Prose

Defined in Data.StringVariants.Prose.Internal

Methods

toJSON :: Prose -> Value

toEncoding :: Prose -> Encoding

toJSONList :: [Prose] -> Value

toEncodingList :: [Prose] -> Encoding

ToJSONKey Prose

Defined in Data.StringVariants.Prose.Internal

Methods

toJSONKey :: ToJSONKeyFunction Prose

toJSONKeyList :: ToJSONKeyFunction [Prose]

Semigroup Prose

Defined in Data.StringVariants.Prose.Internal

Methods

(<>) :: Prose -> Prose -> Prose

sconcat :: NonEmpty Prose -> Prose

stimes :: Integral b => b -> Prose -> Prose

Show Prose

Defined in Data.StringVariants.Prose.Internal

Methods

showsPrec :: Int -> Prose -> ShowS

show :: Prose -> String

showList :: [Prose] -> ShowS

Eq Prose

Defined in Data.StringVariants.Prose.Internal

Methods

(==) :: Prose -> Prose -> Bool

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

Ord Prose

Defined in Data.StringVariants.Prose.Internal

Methods

compare :: Prose -> Prose -> Ordering

(<) :: Prose -> Prose -> Bool

(<=) :: Prose -> Prose -> Bool

(>) :: Prose -> Prose -> Bool

(>=) :: Prose -> Prose -> Bool

max :: Prose -> Prose -> Prose

min :: Prose -> Prose -> Prose

ConvertibleStrings Prose Text

Defined in Data.StringVariants.Prose.Internal

Methods

convertString :: Prose -> Text

ConvertibleStrings Prose Text

Defined in Data.StringVariants.Prose.Internal

Methods

convertString :: Prose -> Text

Lift Prose

Defined in Data.StringVariants.Prose.Internal

Methods

lift :: Quote m => Prose -> m Exp

liftTyped :: forall (m :: Type -> Type). Quote m => Prose -> Code m Prose

mkProse :: Text -> Maybe Prose

compileProse :: QuasiQuoter

proseToText :: Prose -> Text

proseFromNonEmptyText :: NonEmptyText n -> Prose

Nullable non empty text

newtype NullableNonEmptyText n

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

(KnownNat n, 1 <= n) => FromJSON (NullableNonEmptyText n)

Defined in Data.StringVariants.NullableNonEmptyText

Methods

parseJSON :: Value -> Parser (NullableNonEmptyText n)

parseJSONList :: Value -> Parser [NullableNonEmptyText n]

ToJSON (NullableNonEmptyText n)

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)

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)

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)

Defined in Data.StringVariants.NullableNonEmptyText

Methods

showsPrec :: Int -> NullableNonEmptyText n -> ShowS

show :: NullableNonEmptyText n -> String

showList :: [NullableNonEmptyText n] -> ShowS

Eq (NullableNonEmptyText n)

Defined in Data.StringVariants.NullableNonEmptyText

Methods

(==) :: NullableNonEmptyText n -> NullableNonEmptyText n -> Bool

(/=) :: NullableNonEmptyText n -> NullableNonEmptyText n -> Bool

Lift (NullableNonEmptyText n :: TYPE LiftedRep)

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)

Defined in Data.StringVariants.NullableNonEmptyText

type Rep (NullableNonEmptyText n) = D1 ('MetaData "NullableNonEmptyText" "Data.StringVariants.NullableNonEmptyText" "string-variants-0.2.2.0-L1nEobhilOlDqXkUm2lEef" 'True) (C1 ('MetaCons "NullableNonEmptyText" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (NonEmptyText n)))))

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

nullNonEmptyText :: NullableNonEmptyText n

compileNullableNonEmptyText :: Integer -> QuasiQuoter

Converting

nonEmptyTextToNullable :: NonEmptyText n -> NullableNonEmptyText n

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

nullableNonEmptyTextToMaybeText :: NullableNonEmptyText n -> Maybe Text

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

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

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

Information

isNullNonEmptyText :: NullableNonEmptyText n -> Bool