Data.StringVariants.NonEmptyText

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 => Arbitrary (NonEmptyText n)

Defined in Data.StringVariants.NonEmptyText.Internal

Methods

arbitrary :: Gen (NonEmptyText n)

shrink :: NonEmptyText n -> [NonEmptyText n]

KnownNat 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.1.0.1-FzKJzNbSMeN1B3zsrHPi9w" '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

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

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

Since: base-4.16.0.0

Construction

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

unsafeMkNonEmptyText :: forall n. KnownNat n => Text -> NonEmptyText n

Make a NonEmptyText when you can manually verify the length

nonEmptyTextToText :: NonEmptyText n -> Text

compileNonEmptyText :: Integer -> QuasiQuoter

compileNonEmptyTextKnownLength :: QuasiQuoter

convertEmptyTextToNothing :: Text -> Maybe Text

Conversion

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

Converts a NonEmptyText to a wider NonEmptyText

Functions

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

Narrows the maximum length, dropping any remaining trailing characters.

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

Narrows the maximum length, dropping any prefix remaining characters.

chunksOfNonEmptyText :: forall chunkSize totalSize. (KnownNat chunkSize, KnownNat totalSize) => NonEmptyText totalSize -> [NonEmptyText chunkSize]

O(n) Splits a NonEmptyText into components of length chunkSize. The last element may be shorter than the other chunks, depending on the length of the input.

filterNonEmptyText :: (Char -> Bool) -> NonEmptyText n -> 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.

(<>|) :: 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.1.0.1-FzKJzNbSMeN1B3zsrHPi9w" '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

Convenience util if you need a NonEmptyText of a dynamically determined lengths

useNat :: Integer -> (forall n proxy. KnownNat n => proxy n -> x) -> x

natOfLength :: proxy (n :: Nat) -> f (other n) -> f (other n)