ASCII.Refinement

ASCII type constructor

data ASCII superset

This type constructor indicates that a value from some ASCII superset is valid ASCII. The 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 Text may contain only ASCII characters.

Instances

Eq superset => Eq (ASCII superset)

Defined in ASCII.Refinement

Methods

(==) :: ASCII superset -> ASCII superset -> Bool

(/=) :: ASCII superset -> ASCII superset -> Bool

Data superset => Data (ASCII superset)

Defined in ASCII.Refinement

Methods

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

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

toConstr :: ASCII superset -> Constr

dataTypeOf :: ASCII superset -> DataType

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

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

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

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

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

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

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

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

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

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

Ord superset => Ord (ASCII superset)

Defined in ASCII.Refinement

Methods

compare :: ASCII superset -> ASCII superset -> Ordering

(<) :: ASCII superset -> ASCII superset -> Bool

(<=) :: ASCII superset -> ASCII superset -> Bool

(>) :: ASCII superset -> ASCII superset -> Bool

(>=) :: ASCII superset -> ASCII superset -> Bool

max :: ASCII superset -> ASCII superset -> ASCII superset

min :: ASCII superset -> ASCII superset -> ASCII superset

Show superset => Show (ASCII superset)

Defined in ASCII.Refinement

Methods

showsPrec :: Int -> ASCII superset -> ShowS

show :: ASCII superset -> String

showList :: [ASCII superset] -> ShowS

Generic (ASCII superset)

Defined in ASCII.Refinement

Associated Types

type Rep (ASCII superset) :: Type -> Type

Methods

from :: ASCII superset -> Rep (ASCII superset) x

to :: Rep (ASCII superset) x -> ASCII superset

Semigroup superset => Semigroup (ASCII superset)

Defined in ASCII.Refinement

Methods

(<>) :: ASCII superset -> ASCII superset -> ASCII superset

sconcat :: NonEmpty (ASCII superset) -> ASCII superset

stimes :: Integral b => b -> ASCII superset -> ASCII superset

Monoid superset => Monoid (ASCII superset)

Defined in ASCII.Refinement

Methods

mempty :: ASCII superset

mappend :: ASCII superset -> ASCII superset -> ASCII superset

mconcat :: [ASCII superset] -> ASCII superset

Hashable superset => Hashable (ASCII superset)

Defined in ASCII.Refinement

Methods

hashWithSalt :: Int -> ASCII superset -> Int

hash :: ASCII superset -> Int

StringSuperset string => StringSuperset (ASCII string)

Defined in ASCII.Refinement

Methods

isAsciiString :: ASCII string -> Bool

fromCharList :: [Char] -> ASCII string

toCharListUnsafe :: ASCII string -> [Char]

toCharListSub :: ASCII string -> [Char]

substituteString :: ASCII string -> ASCII string

mapCharsUnsafe :: (Char -> Char) -> ASCII string -> ASCII string

CharSuperset char => CharSuperset (ASCII char)

Defined in ASCII.Refinement

Methods

isAsciiChar :: ASCII char -> Bool

fromChar :: Char -> ASCII char

toCharUnsafe :: ASCII char -> Char

StringSuperset string => StringIso (ASCII string)

Defined in ASCII.Refinement

Methods

toCharList :: ASCII string -> [Char]

mapChars :: (Char -> Char) -> ASCII string -> ASCII string

CharSuperset char => CharIso (ASCII char)

Defined in ASCII.Refinement

Methods

toChar :: ASCII char -> Char

Lift (ASCII superset) superset

A value from an ASCII superset that has been refined by the ASCII type constructor may be lifted back into the superset by unwrapping it from the ASCII type.

Defined in ASCII.Lift

Methods

lift :: ASCII superset -> superset

type Rep (ASCII superset)

Defined in ASCII.Refinement

type Rep (ASCII superset) = D1 ('MetaData "ASCII" "ASCII.Refinement" "ascii-superset-1.0.1.8-GuKIfXzsfU0Bz1p0RbXOC3" 'True) (C1 ('MetaCons "ASCII_Unsafe" 'PrefixI 'True) (S1 ('MetaSel ('Just "lift") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 superset)))

lift :: ASCII superset -> superset

asciiUnsafe :: superset -> ASCII superset

Character functions

validateChar :: CharSuperset superset => superset -> Maybe (ASCII superset)

>>> map validateChar [-1, 65, 97, 128] :: [Maybe (ASCII Int)]
[Nothing,Just (asciiUnsafe 65),Just (asciiUnsafe 97),Nothing]

fromChar :: CharSuperset superset => Char -> ASCII superset

toChar :: CharSuperset superset => ASCII superset -> Char

substituteChar :: CharSuperset superset => superset -> ASCII superset

asChar :: CharSuperset superset => (Char -> Char) -> ASCII superset -> ASCII superset

String functions

validateString :: StringSuperset superset => superset -> Maybe (ASCII superset)

>>> map validateString ["Hello", "Cristóbal"] :: [Maybe (ASCII Text)]
[Just (asciiUnsafe "Hello"),Nothing]

>>> map validateString ["Hello", "Cristóbal"] :: [Maybe (ASCII String)]
[Just (asciiUnsafe "Hello"),Nothing]

fromCharList :: StringSuperset superset => [Char] -> ASCII superset

>>> fromCharList [CapitalLetterH,SmallLetterI,ExclamationMark] :: ASCII Text
asciiUnsafe "Hi!"

toCharList :: StringSuperset superset => ASCII superset -> [Char]

>>> toCharList (substituteString "Piñata" :: ASCII Text)
[CapitalLetterP,SmallLetterI,Substitute,SmallLetterA,SmallLetterT,SmallLetterA]

substituteString :: StringSuperset superset => superset -> ASCII superset

Forces a string from a larger character set into ASCII by using the Substitute character in place of any non-ASCII characters.

>>> substituteString "Cristóbal" :: ASCII Text
asciiUnsafe "Crist\SUBbal"

mapChars :: StringSuperset superset => (Char -> Char) -> ASCII superset -> ASCII superset