Hpp.StringSig

Documentation

data CharOrSub s

Constructors

CharMatch !s !s

SubMatch !s !s

NoMatch

class (IsString s, Monoid s) => Stringy s where

A collection of operations relating to sequences of characters.

Minimal complete definition

stringify, unquote, trimSpaces, breakOn, breakCharOrSub, cons, uncons, snoc, unsnoc, sdrop, sbreak, sall, sIsPrefixOf, isEmpty, readLines, putStringy, toChars, copy

Methods

stringify :: s -> s

Stringification puts double quotes around a string and backslashes before existing double quote characters and backslash characters.

unquote :: s -> s

Remove double quote characters from the ends of a string.

trimSpaces :: s -> s

Trim trailing spaces from a String

breakOn :: [(s, t)] -> s -> Maybe (t, s, s)

Similar to the function of the same name in the text package.

breakOn needles haystack finds the first instance of an element of needles in haystack. The first component of the result is the needle tag, the second component is the prefix of haystack before the matched needle, the third component is the remainder of the haystack after the needle..

breakCharOrSub :: Char -> s -> s -> CharOrSub s

A special case of breakOn in which we are looking for either a special character or a particular substring.

cons :: Char -> s -> s

uncons :: s -> Maybe (Char, s)

snoc :: s -> Char -> s

unsnoc :: s -> Maybe (s, Char)

sdrop :: Int -> s -> s

sbreak :: (Char -> Maybe t) -> s -> Maybe (t, s, s)

sall :: (Char -> Bool) -> s -> Bool

sIsPrefixOf :: s -> s -> Bool

isEmpty :: s -> Bool

readLines :: FilePath -> IO [s]

putStringy :: Handle -> s -> IO ()

toChars :: s -> [Char]

copy :: s -> s

An opportunity to copy a string to its own storage to help with GC

Instances

Stringy String

Methods

stringify :: String -> String

unquote :: String -> String

trimSpaces :: String -> String

breakOn :: [(String, t)] -> String -> Maybe (t, String, String)

breakCharOrSub :: Char -> String -> String -> CharOrSub String

cons :: Char -> String -> String

uncons :: String -> Maybe (Char, String)

snoc :: String -> Char -> String

unsnoc :: String -> Maybe (String, Char)

sdrop :: Int -> String -> String

sbreak :: (Char -> Maybe t) -> String -> Maybe (t, String, String)

sall :: (Char -> Bool) -> String -> Bool

sIsPrefixOf :: String -> String -> Bool

isEmpty :: String -> Bool

readLines :: FilePath -> IO [String]

putStringy :: Handle -> String -> IO ()

toChars :: String -> [Char]

copy :: String -> String

Stringy ByteString

Methods

stringify :: ByteString -> ByteString

unquote :: ByteString -> ByteString

trimSpaces :: ByteString -> ByteString

breakOn :: [(ByteString, t)] -> ByteString -> Maybe (t, ByteString, ByteString)

breakCharOrSub :: Char -> ByteString -> ByteString -> CharOrSub ByteString

cons :: Char -> ByteString -> ByteString

uncons :: ByteString -> Maybe (Char, ByteString)

snoc :: ByteString -> Char -> ByteString

unsnoc :: ByteString -> Maybe (ByteString, Char)

sdrop :: Int -> ByteString -> ByteString

sbreak :: (Char -> Maybe t) -> ByteString -> Maybe (t, ByteString, ByteString)

sall :: (Char -> Bool) -> ByteString -> Bool

sIsPrefixOf :: ByteString -> ByteString -> Bool

isEmpty :: ByteString -> Bool

readLines :: FilePath -> IO [ByteString]

putStringy :: Handle -> ByteString -> IO ()

toChars :: ByteString -> [Char]

copy :: ByteString -> ByteString

boolJust :: Bool -> Maybe ()

predicateJust :: (a -> Bool) -> a -> Maybe a

sdropWhile :: Stringy s => (Char -> Bool) -> s -> s

pattern (:.) :: Stringy s => Char -> s -> s infixr 5

pattern Nil :: Stringy s => s