ASCII.CaseRefinement

ASCII'case type constructor

data ASCII'case (letterCase :: Case) superset

Indicates that a value from some ASCII superset is valid ASCII, and also that any letters belong to a particular Case indicated by the letterCase type parameter

The superset type parameter is the ASCII superset, which should be a type with an instance of either CharSuperset or StringSuperset.

For example, whereas a Text value may contain a combination of ASCII and non-ASCII characters, a value of type ASCII'case 'UpperCase Text may contain only uppercase ASCII letters and ASCII non-letters.

Instances

(FromChar superset, KnownCase letterCase) => ToCasefulChar letterCase (ASCII'case letterCase superset)

Defined in ASCII.CaseRefinement

Methods

toCasefulChar :: CaselessChar -> ASCII'case letterCase superset

(FromString superset, KnownCase letterCase) => ToCasefulString letterCase (ASCII'case letterCase superset)

Defined in ASCII.CaseRefinement

Methods

toCasefulString :: [CaselessChar] -> ASCII'case letterCase superset

ToCaselessChar char => ToCaselessChar (ASCII'case letterCase char)

Defined in ASCII.CaseRefinement

Methods

isAsciiCaselessChar :: ASCII'case letterCase char -> Bool

toCaselessCharUnsafe :: ASCII'case letterCase char -> CaselessChar

ToCaselessString string => ToCaselessString (ASCII'case letterCase string)

Defined in ASCII.CaseRefinement

Methods

isAsciiCaselessString :: ASCII'case letterCase string -> Bool

toCaselessCharListUnsafe :: ASCII'case letterCase string -> [CaselessChar]

toCaselessCharListSub :: ASCII'case letterCase string -> [CaselessChar]

CharSuperset char => ToChar (ASCII'case letterCase char)

Defined in ASCII.CaseRefinement

Methods

isAsciiChar :: ASCII'case letterCase char -> Bool

toCharUnsafe :: ASCII'case letterCase char -> Char

ToString string => ToString (ASCII'case letterCase string)

Defined in ASCII.CaseRefinement

Methods

isAsciiString :: ASCII'case letterCase string -> Bool

toCharListUnsafe :: ASCII'case letterCase string -> [Char]

toCharListSub :: ASCII'case letterCase string -> [Char]

ToText (ASCII'case letterCase ByteString)

Defined in ASCII.Superset.Text

Methods

toStrictText :: ASCII'case letterCase ByteString -> Text

toLazyText :: ASCII'case letterCase ByteString -> Text

toUnicodeCharList :: ASCII'case letterCase ByteString -> [Char]

ToText (ASCII'case letterCase ByteString)

Defined in ASCII.Superset.Text

Methods

toStrictText :: ASCII'case letterCase ByteString -> Text

toLazyText :: ASCII'case letterCase ByteString -> Text

toUnicodeCharList :: ASCII'case letterCase ByteString -> [Char]

ToText (ASCII'case letterCase Text)

Defined in ASCII.Superset.Text

Methods

toStrictText :: ASCII'case letterCase Text -> Text

toLazyText :: ASCII'case letterCase Text -> Text0

toUnicodeCharList :: ASCII'case letterCase Text -> [Char]

ToText (ASCII'case letterCase Text)

Defined in ASCII.Superset.Text

Methods

toStrictText :: ASCII'case letterCase Text -> Text0

toLazyText :: ASCII'case letterCase Text -> Text

toUnicodeCharList :: ASCII'case letterCase Text -> [Char]

ToText (ASCII'case letterCase [Char])

Defined in ASCII.Superset.Text

Methods

toStrictText :: ASCII'case letterCase [Char] -> Text

toLazyText :: ASCII'case letterCase [Char] -> Text

toUnicodeCharList :: ASCII'case letterCase [Char] -> [Char]

(Data superset, Typeable letterCase) => Data (ASCII'case letterCase superset)

Defined in ASCII.CaseRefinement

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ASCII'case letterCase superset -> c (ASCII'case letterCase superset)

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c (ASCII'case letterCase superset)

toConstr :: ASCII'case letterCase superset -> Constr

dataTypeOf :: ASCII'case letterCase superset -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c (ASCII'case letterCase superset))

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c (ASCII'case letterCase superset))

gmapT :: (forall b. Data b => b -> b) -> ASCII'case letterCase superset -> ASCII'case letterCase superset

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ASCII'case letterCase superset -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ASCII'case letterCase superset -> r

gmapQ :: (forall d. Data d => d -> u) -> ASCII'case letterCase superset -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ASCII'case letterCase superset -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ASCII'case letterCase superset -> m (ASCII'case letterCase superset)

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ASCII'case letterCase superset -> m (ASCII'case letterCase superset)

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ASCII'case letterCase superset -> m (ASCII'case letterCase superset)

Monoid superset => Monoid (ASCII'case letterCase superset)

Defined in ASCII.CaseRefinement

Methods

mempty :: ASCII'case letterCase superset

mappend :: ASCII'case letterCase superset -> ASCII'case letterCase superset -> ASCII'case letterCase superset

mconcat :: [ASCII'case letterCase superset] -> ASCII'case letterCase superset

Semigroup superset => Semigroup (ASCII'case letterCase superset)

Defined in ASCII.CaseRefinement

Methods

(<>) :: ASCII'case letterCase superset -> ASCII'case letterCase superset -> ASCII'case letterCase superset

sconcat :: NonEmpty (ASCII'case letterCase superset) -> ASCII'case letterCase superset

stimes :: Integral b => b -> ASCII'case letterCase superset -> ASCII'case letterCase superset

Generic (ASCII'case letterCase superset)

Defined in ASCII.CaseRefinement

Associated Types

type Rep (ASCII'case letterCase superset) :: Type -> Type

Methods

from :: ASCII'case letterCase superset -> Rep (ASCII'case letterCase superset) x

to :: Rep (ASCII'case letterCase superset) x -> ASCII'case letterCase superset

Show superset => Show (ASCII'case letterCase superset)

Defined in ASCII.CaseRefinement

Methods

showsPrec :: Int -> ASCII'case letterCase superset -> ShowS

show :: ASCII'case letterCase superset -> String

showList :: [ASCII'case letterCase superset] -> ShowS

Eq superset => Eq (ASCII'case letterCase superset)

Defined in ASCII.CaseRefinement

Methods

(==) :: ASCII'case letterCase superset -> ASCII'case letterCase superset -> Bool

(/=) :: ASCII'case letterCase superset -> ASCII'case letterCase superset -> Bool

Ord superset => Ord (ASCII'case letterCase superset)

Defined in ASCII.CaseRefinement

Methods

compare :: ASCII'case letterCase superset -> ASCII'case letterCase superset -> Ordering

(<) :: ASCII'case letterCase superset -> ASCII'case letterCase superset -> Bool

(<=) :: ASCII'case letterCase superset -> ASCII'case letterCase superset -> Bool

(>) :: ASCII'case letterCase superset -> ASCII'case letterCase superset -> Bool

(>=) :: ASCII'case letterCase superset -> ASCII'case letterCase superset -> Bool

max :: ASCII'case letterCase superset -> ASCII'case letterCase superset -> ASCII'case letterCase superset

min :: ASCII'case letterCase superset -> ASCII'case letterCase superset -> ASCII'case letterCase superset

Hashable superset => Hashable (ASCII'case letterCase superset)

Defined in ASCII.CaseRefinement

Methods

hashWithSalt :: Int -> ASCII'case letterCase superset -> Int

hash :: ASCII'case letterCase superset -> Int

Lift (ASCII'case letterCase superset) superset

Defined in ASCII.Lift

Methods

lift :: ASCII'case letterCase superset -> superset

Lift (ASCII'case letterCase superset) (ASCII superset)

Defined in ASCII.Lift

Methods

lift :: ASCII'case letterCase superset -> ASCII superset

type Rep (ASCII'case letterCase superset)

Defined in ASCII.CaseRefinement

type Rep (ASCII'case letterCase superset) = D1 ('MetaData "ASCII'case" "ASCII.CaseRefinement" "ascii-superset-1.2.7.0-5COrj9fA37c3yqGgQp2pb7" 'True) (C1 ('MetaCons "ASCII'case_Unsafe" 'PrefixI 'True) (S1 ('MetaSel ('Just "lift") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 superset)))

lift :: ASCII'case letterCase superset -> superset

Discard the evidence that the value is known to consist entirely of ASCII characters in a particular case

asciiCaseUnsafe :: superset -> ASCII'case letterCase superset

Change the type of an ASCII superset value that is known to be valid ASCII where letters are restricted to the Case designated by the letterCase type variable

This is "unsafe" because this assertion is unchecked, so this function is capable of producing an invalid ASCII'case value.

forgetCase :: ASCII'case letterCase superset -> ASCII superset

Aliases

The ASCII'upper and ASCII'lower type aliases exist primarily so that you can use ASCII'case without the DataKinds language extension.

type ASCII'upper superset = ASCII'case 'UpperCase superset

type ASCII'lower superset = ASCII'case 'LowerCase superset

Character functions

validateChar

Arguments

:: forall letterCase superset. KnownCase letterCase

=> CharSuperset superset

=> superset

Character which may or may not be in the ASCII character set; if a letter, may be in any case

-> Maybe (ASCII'case letterCase superset)

Return Just an ASCII'case character if the input is an ASCII character in the proper case, or Nothing otherwise

fromCaselessChar

Arguments

:: forall letterCase superset. KnownCase letterCase

=> CharSuperset superset

=> CaselessChar

Character which, if it is a letter, does not have a specified case

-> ASCII'case letterCase superset

Lift a CaselessChar into a superset type, wrapped in the ASCII'case refinement to save the evidence that it is ASCII in a particular case

toCaselessChar

Arguments

:: CharSuperset superset

=> ASCII'case letterCase superset

Character that is known to be ASCII, and in the particular case if it is a letter

-> CaselessChar

Given a character from some type that is known to represent an ASCII character in a particular case, obtain the caseless ASCII character it represents

substituteChar :: forall letterCase superset. KnownCase letterCase => CharSuperset superset => superset -> ASCII'case letterCase superset

Return an ASCII'case character if the input is an ASCII character in the proper case, or Substitute otherwise

asCaselessChar

Arguments

:: forall letterCase superset. KnownCase letterCase

=> CharSuperset superset

=> (CaselessChar -> CaselessChar)

Case-insensitive function over ASCII characters

-> ASCII'case letterCase superset

Character that is known to be ASCII, and in the particular case if it is a letter

-> ASCII'case letterCase superset

Given a character from a larger set that is known to represent an ASCII character, manipulate it as if it were an ASCII character

refineCharToCase :: forall letterCase char. KnownCase letterCase => CharSuperset char => ASCII char -> ASCII'case letterCase char

Given an ASCII superset character that is known to be valid ASCII, refine it further by converting it to a particular letter case

String functions

validateString

Arguments

:: forall letterCase superset. KnownCase letterCase

=> StringSuperset superset

=> superset

String which may or may not be valid ASCII, where letters may be in any case

-> Maybe (ASCII'case letterCase superset)

Return Just an ASCII'case string if the input consists entirely of ASCII characters in the proper case, or Nothing otherwise

fromCaselessCharList

Arguments

:: forall letterCase superset. KnownCase letterCase

=> StringSuperset superset

=> [CaselessChar]

Case-insensitive ASCII string represented as a list of caseless characters

-> ASCII'case letterCase superset

Lift a list of CaselessChar into a superset string type, wrapped in the ASCII'case refinement to save the evidence that all of the characters in the string are ASCII in a particular case

toCaselessCharList

Arguments

:: forall letterCase superset. KnownCase letterCase

=> StringSuperset superset

=> ASCII'case letterCase superset

String that is known to be valid ASCII in a particular case

-> [CaselessChar]

Given a string from some type that is known to represent only ASCII characters in a particular case, obtain the caseless characters it represents

substituteString

Arguments

:: forall letterCase superset. KnownCase letterCase

=> StringSuperset superset

=> superset

String which may or may not be valid ASCII, where letters may be in any case

-> ASCII'case letterCase superset

Forces a string from a larger character set into cased ASCII by using the Substitute character in place of any unacceptable characters

mapChars

Arguments

:: forall letterCase superset. KnownCase letterCase

=> StringSuperset superset

=> (CaselessChar -> CaselessChar)

Case-insensitive function over ASCII characters

-> ASCII'case letterCase superset

String that is known to be valid ASCII in a particular case

-> ASCII'case letterCase superset

Given a string from a larger set that is known to consist entirely of ASCII characters in a particular case, map over the characters in the string as if they were caseless ASCII characters

refineStringToCase :: forall letterCase char. KnownCase letterCase => StringSuperset char => ASCII char -> ASCII'case letterCase char

Given an ASCII superset string that is known to be valid ASCII, refine it further by converting it to a particular letter case

KnownCase

class KnownCase (letterCase :: Case) where

Methods

theCase :: Case

Instances

KnownCase 'LowerCase

Defined in ASCII.CaseRefinement

Methods

theCase :: Case

KnownCase 'UpperCase

Defined in ASCII.CaseRefinement

Methods

theCase :: Case