What4.Utils.Word16String

Documentation

data Word16String

A string of Word16 values, encoded as a bytestring in little endian (LE) order.

We maintain the invariant that Word16Strings are represented by an even number of bytes.

Instances

Eq Word16String

Defined in What4.Utils.Word16String

Methods

(==) :: Word16String -> Word16String -> Bool

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

Ord Word16String

Defined in What4.Utils.Word16String

Methods

compare :: Word16String -> Word16String -> Ordering

(<) :: Word16String -> Word16String -> Bool

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

(>) :: Word16String -> Word16String -> Bool

(>=) :: Word16String -> Word16String -> Bool

max :: Word16String -> Word16String -> Word16String

min :: Word16String -> Word16String -> Word16String

Show Word16String

Defined in What4.Utils.Word16String

Methods

showsPrec :: Int -> Word16String -> ShowS

show :: Word16String -> String

showList :: [Word16String] -> ShowS

Semigroup Word16String

Defined in What4.Utils.Word16String

Methods

(<>) :: Word16String -> Word16String -> Word16String

sconcat :: NonEmpty Word16String -> Word16String

stimes :: Integral b => b -> Word16String -> Word16String

Monoid Word16String

Defined in What4.Utils.Word16String

Methods

mempty :: Word16String

mappend :: Word16String -> Word16String -> Word16String

mconcat :: [Word16String] -> Word16String

Hashable Word16String

Defined in What4.Utils.Word16String

Methods

hashWithSalt :: Int -> Word16String -> Int

hash :: Word16String -> Int

fromLEByteString :: ByteString -> Word16String

Generate a Word16String from a bytestring where the 16bit words are encoded as two bytes in little-endian order.

PRECONDITION: the input bytestring must have a length which is a multiple of 2.

toLEByteString :: Word16String -> ByteString

Return the underlying little endian bytestring.

empty :: Word16String

Return the empty string

singleton :: Word16 -> Word16String

Compute the string containing just the given character

null :: Word16String -> Bool

Test if the given string is empty

index :: Word16String -> Int -> Word16

Retrive the nth character of the string. Out of bounds accesses will cause an error.

drop :: Int -> Word16String -> Word16String

take :: Int -> Word16String -> Word16String

append :: Word16String -> Word16String -> Word16String

length :: Word16String -> Int

foldl' :: (a -> Word16 -> a) -> a -> Word16String -> a

findSubstring :: Word16String -> Word16String -> Maybe Int

Find the first index (if it exists) where the first string appears as a substring in the second

isInfixOf :: Word16String -> Word16String -> Bool

Returns true if the first string appears somewhere in the second string.

isPrefixOf :: Word16String -> Word16String -> Bool

isSuffixOf :: Word16String -> Word16String -> Bool