Data.String.Like

The module defines a typeclass that can be implemented to provide a uniform interface for String-like objects (like String, Text, etc.).

The typeclass itself has default implementations that convert the StringLike item first to a lazy Text, then performs the operation, and converts results back to its StringLike object. This is usually not as efficient as an operation for that specific type. Therefore it is advisable to implement the other functions as well. One can however decide to only implement fromText and toText; or toString.

The module contains instances for String, Text, Text, ByteString and ByteString.

Documentation

class IsString a => StringLike a where

A typeclass that provides a uniform interface for string-like objects.

Minimal complete definition

fromText, toText | toString

Methods

empty :: a

Return an empty string-like object.

cons :: Char -> a -> a

Create a stringlike object by prepending a Char to an already existing string-like object.

snoc :: a -> Char -> a

Create a stringlike object by appending a Char at the end of an already existing string-like object.

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

Unpack a stringlike object by obtaining the first character, and the rest of the string, given the string is non-empty. Nothing otherwise.

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

Unpack a string-like object by obtaining te last character, and the string without the last character, given the string is non-empty. Nothing otherwise.

length :: a -> Int

Obtain the length of the string-like object.

compareLength :: a -> Int -> Ordering

Compare the length of the string with the given length. Returns EQ if the string has the same length, LT if the string is shorter, and GT if the string is longer. If the length is not explicitly stored, this function can stop from the moment the string-like object is exhausted, or the threshold has been reached.

toString :: a -> String

Convert the given string-like object to a String. If not specified, it will use toText, and then unpack the Text object in a String.

fromChar :: Char -> a

Convert a given Char to a string-like object containing the single character.

strConcat :: [a] -> a

Concatenate the list of string-like objects to a string-like object.

strConcatMap :: (Char -> a) -> a -> a

Create a string-like object by mapping each character to another string-like object, and concatenate these.

strAny :: (Char -> Bool) -> a -> Bool

Check if any of the Chars in the string-like object satisfy a given condition.

strAll :: (Char -> Bool) -> a -> Bool

Check if all of the Chars of the string-like object satisfy a given condition.

strNull :: a -> Bool

Check if the given string is empty.

append :: a -> a -> a

Append two string-like objects to a new string-like object.

strMap :: (Char -> Char) -> a -> a

Map all the characters of a string-like object to a new string-like object.

intercalate :: a -> [a] -> a

Inserts the given string-like object in between the string-like objects in the list. For example to make a comma-separated string.

intersperse :: Char -> a -> a

Inserts the given character in between the string-like objects in the list. For example to make a string of words.

transpose :: [a] -> [a]

Transposes the rows and columns of the list of string-like objects.

reverse :: a -> a

Calculate the reverse string of the given string.

toLower :: a -> a

Convert the given string-like object to its lowercase equivalent.

toUpper :: a -> a

Convert the given string-like object to its uppercase equivalent.

toTitle :: a -> a

Convert the given string-like object to its title-case equivalent.

fromText :: Text -> a

Convert a Text object to the string-like object.

toText :: a -> Text

Convert the string-like object to an Text object.

Instances

StringLike ByteString

Defined in Data.String.Like

Methods

empty :: ByteString

cons :: Char -> ByteString -> ByteString

snoc :: ByteString -> Char -> ByteString

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

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

length :: ByteString -> Int

compareLength :: ByteString -> Int -> Ordering

toString :: ByteString -> String

fromChar :: Char -> ByteString

strConcat :: [ByteString] -> ByteString

strConcatMap :: (Char -> ByteString) -> ByteString -> ByteString

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

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

strNull :: ByteString -> Bool

append :: ByteString -> ByteString -> ByteString

strMap :: (Char -> Char) -> ByteString -> ByteString

intercalate :: ByteString -> [ByteString] -> ByteString

intersperse :: Char -> ByteString -> ByteString

transpose :: [ByteString] -> [ByteString]

reverse :: ByteString -> ByteString

toLower :: ByteString -> ByteString

toUpper :: ByteString -> ByteString

toTitle :: ByteString -> ByteString

fromText :: Text -> ByteString

toText :: ByteString -> Text

StringLike ByteString

Defined in Data.String.Like

Methods

empty :: ByteString

cons :: Char -> ByteString -> ByteString

snoc :: ByteString -> Char -> ByteString

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

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

length :: ByteString -> Int

compareLength :: ByteString -> Int -> Ordering

toString :: ByteString -> String

fromChar :: Char -> ByteString

strConcat :: [ByteString] -> ByteString

strConcatMap :: (Char -> ByteString) -> ByteString -> ByteString

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

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

strNull :: ByteString -> Bool

append :: ByteString -> ByteString -> ByteString

strMap :: (Char -> Char) -> ByteString -> ByteString

intercalate :: ByteString -> [ByteString] -> ByteString

intersperse :: Char -> ByteString -> ByteString

transpose :: [ByteString] -> [ByteString]

reverse :: ByteString -> ByteString

toLower :: ByteString -> ByteString

toUpper :: ByteString -> ByteString

toTitle :: ByteString -> ByteString

fromText :: Text -> ByteString

toText :: ByteString -> Text

StringLike Text

Defined in Data.String.Like

Methods

empty :: Text

cons :: Char -> Text -> Text

snoc :: Text -> Char -> Text

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

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

length :: Text -> Int

compareLength :: Text -> Int -> Ordering

toString :: Text -> String

fromChar :: Char -> Text

strConcat :: [Text] -> Text

strConcatMap :: (Char -> Text) -> Text -> Text

strAny :: (Char -> Bool) -> Text -> Bool

strAll :: (Char -> Bool) -> Text -> Bool

strNull :: Text -> Bool

append :: Text -> Text -> Text

strMap :: (Char -> Char) -> Text -> Text

intercalate :: Text -> [Text] -> Text

intersperse :: Char -> Text -> Text

transpose :: [Text] -> [Text]

reverse :: Text -> Text

toLower :: Text -> Text

toUpper :: Text -> Text

toTitle :: Text -> Text

fromText :: Text -> Text

toText :: Text -> Text

StringLike Text

Defined in Data.String.Like

Methods

empty :: Text

cons :: Char -> Text -> Text

snoc :: Text -> Char -> Text

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

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

length :: Text -> Int

compareLength :: Text -> Int -> Ordering

toString :: Text -> String

fromChar :: Char -> Text

strConcat :: [Text] -> Text

strConcatMap :: (Char -> Text) -> Text -> Text

strAny :: (Char -> Bool) -> Text -> Bool

strAll :: (Char -> Bool) -> Text -> Bool

strNull :: Text -> Bool

append :: Text -> Text -> Text

strMap :: (Char -> Char) -> Text -> Text

intercalate :: Text -> [Text] -> Text

intersperse :: Char -> Text -> Text

transpose :: [Text] -> [Text]

reverse :: Text -> Text

toLower :: Text -> Text

toUpper :: Text -> Text

toTitle :: Text -> Text

fromText :: Text0 -> Text

toText :: Text -> Text0

StringLike [Char]

Defined in Data.String.Like

Methods

empty :: [Char]

cons :: Char -> [Char] -> [Char]

snoc :: [Char] -> Char -> [Char]

uncons :: [Char] -> Maybe (Char, [Char])

unsnoc :: [Char] -> Maybe ([Char], Char)

length :: [Char] -> Int

compareLength :: [Char] -> Int -> Ordering

toString :: [Char] -> String

fromChar :: Char -> [Char]

strConcat :: [[Char]] -> [Char]

strConcatMap :: (Char -> [Char]) -> [Char] -> [Char]

strAny :: (Char -> Bool) -> [Char] -> Bool

strAll :: (Char -> Bool) -> [Char] -> Bool

strNull :: [Char] -> Bool

append :: [Char] -> [Char] -> [Char]

strMap :: (Char -> Char) -> [Char] -> [Char]

intercalate :: [Char] -> [[Char]] -> [Char]

intersperse :: Char -> [Char] -> [Char]

transpose :: [[Char]] -> [[Char]]

reverse :: [Char] -> [Char]

toLower :: [Char] -> [Char]

toUpper :: [Char] -> [Char]

toTitle :: [Char] -> [Char]

fromText :: Text -> [Char]

toText :: [Char] -> Text

class IsString a where

Class for string-like datastructures; used by the overloaded string extension (-XOverloadedStrings in GHC).

Methods

fromString :: String -> a

Instances

IsString ByteString

Defined in Data.ByteString.Lazy.Internal

Methods

fromString :: String -> ByteString

IsString ByteString

Defined in Data.ByteString.Internal

Methods

fromString :: String -> ByteString

a ~ Char => IsString [a]

(a ~ Char) context was introduced in 4.9.0.0

Since: base-2.1

Defined in Data.String

Methods

fromString :: String -> [a]

IsString a => IsString (Identity a)

Since: base-4.9.0.0

Defined in Data.String

Methods

fromString :: String -> Identity a

IsString a => IsString (Const a b)

Since: base-4.9.0.0

Defined in Data.String

Methods

fromString :: String -> Const a b

convertStringLike

Arguments

:: (StringLike a, StringLike b)

=> a

The StringLike object to convert.

-> b

The StringLike object that is the equivalent of the given StringLike object.

Convert from one StringLike type to another StringLike type. This is done through a lazy Text.