ASCII.Superset

Characters

Class

class ToCaselessChar char where

Partial conversion to CaselessChar

Generally this will be a superset of the ASCII character set with a ToChar instance as well, and the conversion will be achieved by discarding the case of letters. A notable exception is the instance for the CaselessChar type itself, which is already represented without case and does not have a ToChar instance.

Methods

isAsciiCaselessChar :: char -> Bool

Test whether a character can be converted to CaselessChar

toCaselessCharUnsafe :: char -> CaselessChar

Conversion to CaselessChar, defined only where isAsciiCaselessChar is satisfied

Instances

ToCaselessChar CaselessChar

CaselessChar is trivially convertible to itself.

Defined in ASCII.Superset

Methods

isAsciiCaselessChar :: CaselessChar -> Bool

toCaselessCharUnsafe :: CaselessChar -> CaselessChar

ToCaselessChar Char

Defined in ASCII.Superset

Methods

isAsciiCaselessChar :: Char -> Bool

toCaselessCharUnsafe :: Char -> CaselessChar

ToCaselessChar Word8

Defined in ASCII.Superset

Methods

isAsciiCaselessChar :: Word8 -> Bool

toCaselessCharUnsafe :: Word8 -> CaselessChar

ToCaselessChar Natural

Defined in ASCII.Superset

Methods

isAsciiCaselessChar :: Natural -> Bool

toCaselessCharUnsafe :: Natural -> CaselessChar

ToCaselessChar Char

Defined in ASCII.Superset

Methods

isAsciiCaselessChar :: Char -> Bool

toCaselessCharUnsafe :: Char -> CaselessChar

ToCaselessChar Int

Defined in ASCII.Superset

Methods

isAsciiCaselessChar :: Int -> Bool

toCaselessCharUnsafe :: Int -> CaselessChar

ToCaselessChar char => ToCaselessChar (ASCII char)

Defined in ASCII.Refinement.Internal

Methods

isAsciiCaselessChar :: ASCII char -> Bool

toCaselessCharUnsafe :: ASCII char -> CaselessChar

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

Defined in ASCII.CaseRefinement

Methods

isAsciiCaselessChar :: ASCII'case letterCase char -> Bool

toCaselessCharUnsafe :: ASCII'case letterCase char -> CaselessChar

class ToCaselessChar char => ToChar char where

Partial conversion to Char

This includes the Char type itself, character sets that are supersets of ASCII, and numeric types such as Word8 that are often used to represent ASCII characters.

This does not include CaselessChar, because that cannot be converted to Char without choosing a case.

Methods

isAsciiChar :: char -> Bool

Test whether a character can be converted to Char

toCharUnsafe :: char -> Char

Conversion to Char, defined only where isAsciiChar is satisfied

Instances

ToChar Char

Defined in ASCII.Superset

Methods

isAsciiChar :: Char -> Bool

toCharUnsafe :: Char -> Char

ToChar Word8

Defined in ASCII.Superset

Methods

isAsciiChar :: Word8 -> Bool

toCharUnsafe :: Word8 -> Char

ToChar Natural

Defined in ASCII.Superset

Methods

isAsciiChar :: Natural -> Bool

toCharUnsafe :: Natural -> Char

ToChar Char

Defined in ASCII.Superset

Methods

isAsciiChar :: Char -> Bool

toCharUnsafe :: Char -> Char0

ToChar Int

Defined in ASCII.Superset

Methods

isAsciiChar :: Int -> Bool

toCharUnsafe :: Int -> Char

CharSuperset char => ToChar (ASCII char)

Defined in ASCII.Refinement.Internal

Methods

isAsciiChar :: ASCII char -> Bool

toCharUnsafe :: ASCII char -> Char

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

Defined in ASCII.CaseRefinement

Methods

isAsciiChar :: ASCII'case letterCase char -> Bool

toCharUnsafe :: ASCII'case letterCase char -> Char

class FromChar char where

Total conversion from Char

This class includes supersets of ASCII, in which case fromChar is a lifting function. It also includes CaselessChar, in which case fromChar discards case information.

This does not include ASCII'case, because that represents a subset of Char; not all characters are of the wanted case, so no total conversion is possible without changing case.

Methods

fromChar :: Char -> char

Conversion from Char

Instances

FromChar CaselessChar

Defined in ASCII.Superset

Methods

fromChar :: Char -> CaselessChar

FromChar Char

Defined in ASCII.Superset

Methods

fromChar :: Char -> Char

FromChar Word8

Defined in ASCII.Superset

Methods

fromChar :: Char -> Word8

FromChar Natural

Defined in ASCII.Superset

Methods

fromChar :: Char -> Natural

FromChar Char

Defined in ASCII.Superset

Methods

fromChar :: Char0 -> Char

FromChar Int

Defined in ASCII.Superset

Methods

fromChar :: Char -> Int

CharSuperset char => FromChar (ASCII char)

Defined in ASCII.Refinement.Internal

Methods

fromChar :: Char -> ASCII char

class (ToChar char, FromChar char) => CharSuperset char where

Character type with:

• a total conversion from ASCII; and
• a partial conversion to ASCII

Methods

toCaseChar :: Case -> char -> char

Convert a character in the superset to the designated case, if it is an ASCII letter of the opposite case. Otherwise, return the argument unmodified.

Instances

CharSuperset Char

Char is trivially a superset of itself.

Defined in ASCII.Superset

Methods

toCaseChar :: Case -> Char -> Char

CharSuperset Word8

Defined in ASCII.Superset

Methods

toCaseChar :: Case -> Word8 -> Word8

CharSuperset Natural

Defined in ASCII.Superset

Methods

toCaseChar :: Case -> Natural -> Natural

CharSuperset Char

Defined in ASCII.Superset

Methods

toCaseChar :: Case -> Char -> Char

CharSuperset Int

Defined in ASCII.Superset

Methods

toCaseChar :: Case -> Int -> Int

CharSuperset char => CharSuperset (ASCII char)

Defined in ASCII.Refinement.Internal

Methods

toCaseChar :: Case -> ASCII char -> ASCII char

class ToCasefulChar (letterCase :: Case) char where

Methods

toCasefulChar :: CaselessChar -> char

Instances

KnownCase letterCase => ToCasefulChar letterCase Char

Defined in ASCII.Superset

Methods

toCasefulChar :: CaselessChar -> Char

KnownCase letterCase => ToCasefulChar letterCase Word8

Defined in ASCII.Superset

Methods

toCasefulChar :: CaselessChar -> Word8

KnownCase letterCase => ToCasefulChar letterCase Natural

Defined in ASCII.Superset

Methods

toCasefulChar :: CaselessChar -> Natural

KnownCase letterCase => ToCasefulChar letterCase Char

Defined in ASCII.Superset

Methods

toCasefulChar :: CaselessChar -> Char

KnownCase letterCase => ToCasefulChar letterCase Int

Defined in ASCII.Superset

Methods

toCasefulChar :: CaselessChar -> Int

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

Defined in ASCII.CaseRefinement

Methods

toCasefulChar :: CaselessChar -> ASCII'case letterCase superset

Functions

asCharUnsafe :: CharSuperset char => (Char -> Char) -> char -> char

Manipulate a character as if it were an ASCII Char, assuming that it is

Defined only where isAsciiChar is satisfied.

toCharMaybe :: ToChar char => char -> Maybe Char

toCaselessCharMaybe :: ToCaselessChar char => char -> Maybe CaselessChar

toCharOrFail :: (ToChar char, MonadFail context) => char -> context Char

toCaselessCharOrFail :: (ToCaselessChar char, MonadFail context) => char -> context CaselessChar

toCharSub :: ToChar char => char -> Char

toCaselessCharSub :: ToCaselessChar char => char -> CaselessChar

substituteChar :: CharSuperset char => char -> char

Force a character into ASCII by replacing it with Substitute if it is not already an ASCII character

The resulting character satisfies isAsciiChar and isAsciiCaselessChar.

convertCharMaybe :: (ToChar char1, FromChar char2) => char1 -> Maybe char2

Convert from one ASCII-superset character type to another via the ASCII Char type. Fails as Nothing if the input is outside the ASCII character set.

convertCharOrFail :: (ToChar char1, FromChar char2, MonadFail context) => char1 -> context char2

Convert from one ASCII-superset character type to another via the ASCII Char type. Fails with fail if the input is outside the ASCII character set.

Strings

Class

class ToCaselessString string where

Partial conversion to [CaselessChar]

Generally this will be a superset of ASCII strings with a ToString instance as well, and the conversion will be achieved by discarding the case of letters. A notable exception is the instance for [CaselessChar] type itself, which is already represented without case and does not have a ToString instance.

Methods

isAsciiCaselessString :: string -> Bool

Test whether a character can be converted to [CaselessChar]

toCaselessCharListUnsafe :: string -> [CaselessChar]

Conversion to [CaselessChar], defined only where isAsciiCaselessString is satisfied

toCaselessCharListSub :: string -> [CaselessChar]

Conversion to [CaselessChar] achieved by using Substitute in place of any non-ASCII characters

Instances

ToCaselessString Builder

Defined in ASCII.Superset

Methods

isAsciiCaselessString :: Builder -> Bool

toCaselessCharListUnsafe :: Builder -> [CaselessChar]

toCaselessCharListSub :: Builder -> [CaselessChar]

ToCaselessString ByteString

Defined in ASCII.Superset

Methods

isAsciiCaselessString :: ByteString -> Bool

toCaselessCharListUnsafe :: ByteString -> [CaselessChar]

toCaselessCharListSub :: ByteString -> [CaselessChar]

ToCaselessString ByteString

Defined in ASCII.Superset

Methods

isAsciiCaselessString :: ByteString -> Bool

toCaselessCharListUnsafe :: ByteString -> [CaselessChar]

toCaselessCharListSub :: ByteString -> [CaselessChar]

ToCaselessString Text

Defined in ASCII.Superset

Methods

isAsciiCaselessString :: Text -> Bool

toCaselessCharListUnsafe :: Text -> [CaselessChar]

toCaselessCharListSub :: Text -> [CaselessChar]

ToCaselessString Builder

Defined in ASCII.Superset

Methods

isAsciiCaselessString :: Builder -> Bool

toCaselessCharListUnsafe :: Builder -> [CaselessChar]

toCaselessCharListSub :: Builder -> [CaselessChar]

ToCaselessString Text

Defined in ASCII.Superset

Methods

isAsciiCaselessString :: Text -> Bool

toCaselessCharListUnsafe :: Text -> [CaselessChar]

toCaselessCharListSub :: Text -> [CaselessChar]

ToCaselessString string => ToCaselessString (ASCII string)

Defined in ASCII.Refinement.Internal

Methods

isAsciiCaselessString :: ASCII string -> Bool

toCaselessCharListUnsafe :: ASCII string -> [CaselessChar]

toCaselessCharListSub :: ASCII string -> [CaselessChar]

ToCaselessChar char => ToCaselessString [char]

Defined in ASCII.Superset

Methods

isAsciiCaselessString :: [char] -> Bool

toCaselessCharListUnsafe :: [char] -> [CaselessChar]

toCaselessCharListSub :: [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]

class ToCaselessString string => ToString string where

Partial conversion to [Char]

This includes [Char] type itself, strings of character sets that are supersets of ASCII, and sequences of numeric types such as Word8 that are often used to represent ASCII characters.

This does not include [CaselessChar], because that cannot be converted to [Char] without choosing a case.

Methods

isAsciiString :: string -> Bool

Test whether a string can be converted to [Char]

toCharListUnsafe :: string -> [Char]

Conversion to [Char], defined only where isAsciiString is satisfied

toCharListSub :: string -> [Char]

Conversion to [Char] achieved by using Substitute in place of any non-ASCII characters

Instances

ToString Builder

Defined in ASCII.Superset

Methods

isAsciiString :: Builder -> Bool

toCharListUnsafe :: Builder -> [Char]

toCharListSub :: Builder -> [Char]

ToString ByteString

Defined in ASCII.Superset

Methods

isAsciiString :: ByteString -> Bool

toCharListUnsafe :: ByteString -> [Char]

toCharListSub :: ByteString -> [Char]

ToString ByteString

Defined in ASCII.Superset

Methods

isAsciiString :: ByteString -> Bool

toCharListUnsafe :: ByteString -> [Char]

toCharListSub :: ByteString -> [Char]

ToString Text

Defined in ASCII.Superset

Methods

isAsciiString :: Text -> Bool

toCharListUnsafe :: Text -> [Char]

toCharListSub :: Text -> [Char]

ToString Builder

Defined in ASCII.Superset

Methods

isAsciiString :: Builder -> Bool

toCharListUnsafe :: Builder -> [Char]

toCharListSub :: Builder -> [Char]

ToString Text

Defined in ASCII.Superset

Methods

isAsciiString :: Text -> Bool

toCharListUnsafe :: Text -> [Char]

toCharListSub :: Text -> [Char]

ToString string => ToString (ASCII string)

Defined in ASCII.Refinement.Internal

Methods

isAsciiString :: ASCII string -> Bool

toCharListUnsafe :: ASCII string -> [Char]

toCharListSub :: ASCII string -> [Char]

ToChar char => ToString [char]

Defined in ASCII.Superset

Methods

isAsciiString :: [char] -> Bool

toCharListUnsafe :: [char] -> [Char]

toCharListSub :: [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]

class FromString string where

Total conversion from [Char]

This class includes supersets of ASCII, in which case fromCharList lifts each character into the larger character set. It also includes [CaselessChar], in which case fromCharList discards case information from letters.

This does not include [ASCII'case], because that represents a subset of ASCII; not all ASCII characters are of case wanted by ASCII'case, so no total conversion is possible without changing case.

Methods

fromCharList :: [Char] -> string

Conversion from [Char]

Instances

FromString Builder

Defined in ASCII.Superset

Methods

fromCharList :: [Char] -> Builder

FromString ByteString

Defined in ASCII.Superset

Methods

fromCharList :: [Char] -> ByteString

FromString ByteString

Defined in ASCII.Superset

Methods

fromCharList :: [Char] -> ByteString

FromString Text

Defined in ASCII.Superset

Methods

fromCharList :: [Char] -> Text

FromString Builder

Defined in ASCII.Superset

Methods

fromCharList :: [Char] -> Builder

FromString Text

Defined in ASCII.Superset

Methods

fromCharList :: [Char] -> Text

FromString string => FromString (ASCII string)

Defined in ASCII.Refinement.Internal

Methods

fromCharList :: [Char] -> ASCII string

FromChar char => FromString [char]

Defined in ASCII.Superset

Methods

fromCharList :: [Char] -> [char]

class (ToString string, FromString string) => StringSuperset string where

String type with:

• a total conversion from ASCII; and
• a partial conversion to ASCII

Minimal complete definition

substituteString, toCaseString

Methods

substituteString :: string -> string

Force a string into ASCII by replacing any non-ASCII character with Substitute

The resulting string satisfies isAsciiString and isAsciiCaselessString.

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

toCaseString :: Case -> string -> string

Convert each character in the superset to the designated case, if it is an ASCII letter of the opposite case. Leaves other characters unchanged.

Instances

StringSuperset Builder

Defined in ASCII.Superset

Methods

substituteString :: Builder -> Builder

mapCharsUnsafe :: (Char -> Char) -> Builder -> Builder

toCaseString :: Case -> Builder -> Builder

StringSuperset ByteString

Defined in ASCII.Superset

Methods

substituteString :: ByteString -> ByteString

mapCharsUnsafe :: (Char -> Char) -> ByteString -> ByteString

toCaseString :: Case -> ByteString -> ByteString

StringSuperset ByteString

Defined in ASCII.Superset

Methods

substituteString :: ByteString -> ByteString

mapCharsUnsafe :: (Char -> Char) -> ByteString -> ByteString

toCaseString :: Case -> ByteString -> ByteString

StringSuperset Text

Defined in ASCII.Superset

Methods

substituteString :: Text -> Text

mapCharsUnsafe :: (Char -> Char) -> Text -> Text

toCaseString :: Case -> Text -> Text

StringSuperset Builder

Defined in ASCII.Superset

Methods

substituteString :: Builder -> Builder

mapCharsUnsafe :: (Char -> Char) -> Builder -> Builder

toCaseString :: Case -> Builder -> Builder

StringSuperset Text

Defined in ASCII.Superset

Methods

substituteString :: Text -> Text

mapCharsUnsafe :: (Char -> Char) -> Text -> Text

toCaseString :: Case -> Text -> Text

StringSuperset string => StringSuperset (ASCII string)

Defined in ASCII.Refinement.Internal

Methods

substituteString :: ASCII string -> ASCII string

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

toCaseString :: Case -> ASCII string -> ASCII string

CharSuperset char => StringSuperset [char]

Defined in ASCII.Superset

Methods

substituteString :: [char] -> [char]

mapCharsUnsafe :: (Char -> Char) -> [char] -> [char]

toCaseString :: Case -> [char] -> [char]

class ToCasefulString (letterCase :: Case) string where

Methods

toCasefulString :: [CaselessChar] -> string

Instances

KnownCase letterCase => ToCasefulString letterCase Builder

Defined in ASCII.Superset

Methods

toCasefulString :: [CaselessChar] -> Builder

KnownCase letterCase => ToCasefulString letterCase ByteString

Defined in ASCII.Superset

Methods

toCasefulString :: [CaselessChar] -> ByteString

KnownCase letterCase => ToCasefulString letterCase ByteString

Defined in ASCII.Superset

Methods

toCasefulString :: [CaselessChar] -> ByteString

KnownCase letterCase => ToCasefulString letterCase Text

Defined in ASCII.Superset

Methods

toCasefulString :: [CaselessChar] -> Text

KnownCase letterCase => ToCasefulString letterCase Builder

Defined in ASCII.Superset

Methods

toCasefulString :: [CaselessChar] -> Builder

KnownCase letterCase => ToCasefulString letterCase Text

Defined in ASCII.Superset

Methods

toCasefulString :: [CaselessChar] -> Text

(ToCasefulChar letterCase char, KnownCase letterCase) => ToCasefulString letterCase [char]

Defined in ASCII.Superset

Methods

toCasefulString :: [CaselessChar] -> [char]

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

Defined in ASCII.CaseRefinement

Methods

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

Functions

toCharListMaybe :: ToString string => string -> Maybe [Char]

toCaselessCharListMaybe :: ToCaselessString string => string -> Maybe [CaselessChar]

toCharListOrFail :: (ToString string, MonadFail context) => string -> context [Char]

toCaselessCharListOrFail :: (ToCaselessString string, MonadFail context) => string -> context [CaselessChar]

convertStringMaybe :: (ToString string1, FromString string2) => string1 -> Maybe string2

Convert from one ASCII-superset string type to another by converting each character of the input string to an ASCII Char, and then converting the ASCII character list to the desired output type. Fails as Nothing if the input contains any character that is outside the ASCII character set.

convertStringOrFail :: (ToString string1, FromString string2, MonadFail context) => string1 -> context string2

Convert from one ASCII-superset string type to another by converting each character of the input string to an ASCII Char, and then converting the ASCII character list to the desired output type. Fails with fail if the input contains any character that is outside the ASCII character set.