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

Lift (NonEmptyText n :: Type)

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)

(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]

omittedField :: Maybe (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

omitField :: NonEmptyText n -> Bool

KnownNat n => Data (NonEmptyText n)

Defined in Data.StringVariants.NonEmptyText.Internal

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> NonEmptyText n -> c (NonEmptyText n)

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c (NonEmptyText n)

toConstr :: NonEmptyText n -> Constr

dataTypeOf :: NonEmptyText n -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c (NonEmptyText n))

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c (NonEmptyText n))

gmapT :: (forall b. Data b => b -> b) -> NonEmptyText n -> NonEmptyText n

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> NonEmptyText n -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> NonEmptyText n -> r

gmapQ :: (forall d. Data d => d -> u) -> NonEmptyText n -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> NonEmptyText n -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> NonEmptyText n -> m (NonEmptyText n)

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> NonEmptyText n -> m (NonEmptyText n)

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> NonEmptyText n -> m (NonEmptyText n)

(TypeError (('Text "An instance of 'Semigroup (NonEmptyText n)' would violate the " ':<>: 'Text "length guarantees.") ':$$: 'Text "Please use '(<>|)' or 'concatWithSpace' to combine the values.") :: Constraint) => 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

NFData (NonEmptyText n)

Defined in Data.StringVariants.NonEmptyText.Internal

Methods

rnf :: NonEmptyText n -> ()

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

Hashable (NonEmptyText n)

Defined in Data.StringVariants.NonEmptyText.Internal

Methods

hashWithSalt :: Int -> NonEmptyText n -> Int

hash :: NonEmptyText n -> Int

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

type Rep (NonEmptyText n)

Defined in Data.StringVariants.NonEmptyText.Internal

type Rep (NonEmptyText n) = D1 ('MetaData "NonEmptyText" "Data.StringVariants.NonEmptyText.Internal" "string-variants-0.3.1.1-KjbUPF6eB5P27Tc6XbzPLu" '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 :: t) (y :: t) = Assert (x <=? y) (LeErrMsg x y :: Constraint) infix 4

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

Since: base-4.16.0.0

Construction

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

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

type IsNonEmptyText n s = (KnownSymbol s, KnownNat n, SymbolNonEmpty s, SymbolWithNoSpaceAround s, SymbolNoLongerThan s n)

literalNonEmptyText :: forall (s :: Symbol) (n :: Nat). IsNonEmptyText n s => NonEmptyText n

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

Make a NonEmptyText when you can manually verify the length

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

nonEmptyTextToText :: NonEmptyText n -> Text

Functions

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

concatWithSpace :: NonEmptyText n -> NonEmptyText m -> NonEmptyText ((n + m) + 1)

Concat two NonEmptyText values with a space in between them. The new maximum length is the sum of the two maximum lengths of the inputs + 1 for the space.

Useful for unwordslike operations, or combining first and last names.

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.3.1.1-KjbUPF6eB5P27Tc6XbzPLu" '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