Foundation.String

Opaque packed String encoded in UTF8.

The type is an instance of IsString and IsList, which allow OverloadedStrings for string literal, and fromList to convert a [Char] (Prelude String) to a packed representation

{-# LANGUAGE OverloadedStrings #-}
s = "Hello World :: String

s = fromList ("Hello World" :: Prelude.String) :: String

Each unicode code point is represented by a variable encoding of 1 to 4 bytes,

For more information about UTF8: https://en.wikipedia.org/wiki/UTF-8

Documentation

data String

Opaque packed array of characters in the UTF8 encoding

Instances

IsList String

Associated Types

type Item String :: *

Methods

fromList :: [Item String] -> String

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

toList :: String -> [Item String]

Eq String

Methods

(==) :: String -> String -> Bool

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

Ord String

Methods

compare :: String -> String -> Ordering

(<) :: String -> String -> Bool

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

(>) :: String -> String -> Bool

(>=) :: String -> String -> Bool

max :: String -> String -> String

min :: String -> String -> String

Show String

Methods

showsPrec :: Int -> String -> ShowS

show :: String -> String

showList :: [String] -> ShowS

IsString String

Methods

fromString :: String -> String

Monoid String

Methods

mempty :: String

mappend :: String -> String -> String

mconcat :: [String] -> String

InnerFunctor String

Methods

imap :: (Element String -> Element String) -> String -> String

Sequential String

Methods

null :: String -> Bool

take :: Int -> String -> String

revTake :: Int -> String -> String

drop :: Int -> String -> String

revDrop :: Int -> String -> String

splitAt :: Int -> String -> (String, String)

revSplitAt :: Int -> String -> (String, String)

splitOn :: (Element String -> Bool) -> String -> [String]

break :: (Element String -> Bool) -> String -> (String, String)

breakElem :: Element String -> String -> (String, String)

intersperse :: Element String -> String -> String

intercalate :: Element String -> String -> Element String

span :: (Element String -> Bool) -> String -> (String, String)

filter :: (Element String -> Bool) -> String -> String

reverse :: String -> String

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

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

snoc :: String -> Element String -> String

cons :: Element String -> String -> String

find :: (Element String -> Bool) -> String -> Maybe (Element String)

sortBy :: (Element String -> Element String -> Ordering) -> String -> String

length :: String -> Int

singleton :: Element String -> String

Zippable String

Methods

zipWith :: (Sequential a, Sequential b) => (Element a -> Element b -> Element String) -> a -> b -> String

zipWith3 :: (Sequential a, Sequential b, Sequential c) => (Element a -> Element b -> Element c -> Element String) -> a -> b -> c -> String

zipWith4 :: (Sequential a, Sequential b, Sequential c, Sequential d) => (Element a -> Element b -> Element c -> Element d -> Element String) -> a -> b -> c -> d -> String

zipWith5 :: (Sequential a, Sequential b, Sequential c, Sequential d, Sequential e) => (Element a -> Element b -> Element c -> Element d -> Element e -> Element String) -> a -> b -> c -> d -> e -> String

zipWith6 :: (Sequential a, Sequential b, Sequential c, Sequential d, Sequential e, Sequential f) => (Element a -> Element b -> Element c -> Element d -> Element e -> Element f -> Element String) -> a -> b -> c -> d -> e -> f -> String

zipWith7 :: (Sequential a, Sequential b, Sequential c, Sequential d, Sequential e, Sequential f, Sequential g) => (Element a -> Element b -> Element c -> Element d -> Element e -> Element f -> Element g -> Element String) -> a -> b -> c -> d -> e -> f -> g -> String

type Item String

type Item String = Char

type Element String

type Element String = Char

data Encoding

Constructors

ASCII7

UTF8

UTF16

UTF32

ISO_8859_1

Instances

Bounded Encoding

Methods

minBound :: Encoding

maxBound :: Encoding

Enum Encoding

Methods

succ :: Encoding -> Encoding

pred :: Encoding -> Encoding

toEnum :: Int -> Encoding

fromEnum :: Encoding -> Int

enumFrom :: Encoding -> [Encoding]

enumFromThen :: Encoding -> Encoding -> [Encoding]

enumFromTo :: Encoding -> Encoding -> [Encoding]

enumFromThenTo :: Encoding -> Encoding -> Encoding -> [Encoding]

Eq Encoding

Methods

(==) :: Encoding -> Encoding -> Bool

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

Data Encoding

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Encoding -> c Encoding

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Encoding

toConstr :: Encoding -> Constr

dataTypeOf :: Encoding -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c Encoding)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Encoding)

gmapT :: (forall b. Data b => b -> b) -> Encoding -> Encoding

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Encoding -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Encoding -> r

gmapQ :: (forall d. Data d => d -> u) -> Encoding -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Encoding -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Encoding -> m Encoding

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Encoding -> m Encoding

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Encoding -> m Encoding

Ord Encoding

Methods

compare :: Encoding -> Encoding -> Ordering

(<) :: Encoding -> Encoding -> Bool

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

(>) :: Encoding -> Encoding -> Bool

(>=) :: Encoding -> Encoding -> Bool

max :: Encoding -> Encoding -> Encoding

min :: Encoding -> Encoding -> Encoding

Show Encoding

Methods

showsPrec :: Int -> Encoding -> ShowS

show :: Encoding -> String

showList :: [Encoding] -> ShowS

fromBytes :: Encoding -> UArray Word8 -> (String, Maybe ValidationFailure, UArray Word8)

fromBytesLenient :: UArray Word8 -> (String, UArray Word8)

fromBytesUnsafe :: UArray Word8 -> String

Convert a Byte Array directly to a string without checking for UTF8 validity

toBytes :: Encoding -> String -> UArray Word8

Convert a String to a bytearray

data ValidationFailure

Constructors

InvalidHeader

InvalidContinuation

MissingByte

Instances

Eq ValidationFailure

Methods

(==) :: ValidationFailure -> ValidationFailure -> Bool

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

Show ValidationFailure

Methods

showsPrec :: Int -> ValidationFailure -> ShowS

show :: ValidationFailure -> String

showList :: [ValidationFailure] -> ShowS

Exception ValidationFailure

Methods

toException :: ValidationFailure -> SomeException

fromException :: SomeException -> Maybe ValidationFailure

displayException :: ValidationFailure -> String

lines :: String -> [String]

words :: String -> [String]