Basement.Types.AsciiString

A AsciiString type backed by a ASCII encoded byte array and all the necessary functions to manipulate the string.

Documentation

newtype AsciiString

Opaque packed array of characters in the ASCII encoding

Constructors

AsciiString

Fields

• toBytes :: UArray Char7

Instances

IsList AsciiString

Associated Types

type Item AsciiString :: *

Methods

fromList :: [Item AsciiString] -> AsciiString

fromListN :: Int -> [Item AsciiString] -> AsciiString

toList :: AsciiString -> [Item AsciiString]

Eq AsciiString

Methods

(==) :: AsciiString -> AsciiString -> Bool

(/=) :: AsciiString -> AsciiString -> Bool

Ord AsciiString

Methods

compare :: AsciiString -> AsciiString -> Ordering

(<) :: AsciiString -> AsciiString -> Bool

(<=) :: AsciiString -> AsciiString -> Bool

(>) :: AsciiString -> AsciiString -> Bool

(>=) :: AsciiString -> AsciiString -> Bool

max :: AsciiString -> AsciiString -> AsciiString

min :: AsciiString -> AsciiString -> AsciiString

Show AsciiString

Methods

showsPrec :: Int -> AsciiString -> ShowS

show :: AsciiString -> String

showList :: [AsciiString] -> ShowS

IsString AsciiString

Methods

fromString :: String -> AsciiString

Monoid AsciiString

Methods

mempty :: AsciiString

mappend :: AsciiString -> AsciiString -> AsciiString

mconcat :: [AsciiString] -> AsciiString

From AsciiString String

Methods

from :: AsciiString -> String

From AsciiString (UArray Word8)

Methods

from :: AsciiString -> UArray Word8

type Item AsciiString

type Item AsciiString = Char7

newtype MutableAsciiString st

Constructors

MutableAsciiString (MUArray Char7 st)

Binary conversion

fromBytesUnsafe :: UArray Word8 -> AsciiString

Convert a Byte Array representing ASCII data directly to an AsciiString without checking for ASCII validity

If the input contains invalid Char7 value (anything above 0x7f), it will trigger runtime async errors when processing data.

In doubt, use fromBytes

fromBytes :: UArray Word8 -> Maybe AsciiString

Convert a Byte Array representing ASCII checking validity.

If the byte array is not valid, then Nothing is returned