License	BSD-style
Maintainer	Vincent Hanquez <vincent@snarc.org>
Stability	experimental
Portability	portable
Safe Haskell	None
Language	Haskell2010

Foundation.String

Description

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 #

Instances

Instances details

NormalForm String

Instance details

Defined in Basement.UTF8.Base

Methods

toNormalForm :: String -> () #

Arbitrary String Source #

Instance details

Defined in Foundation.Check.Arbitrary

Methods

arbitrary :: Gen String Source #

Buildable String Source #

Instance details

Defined in Foundation.Collection.Buildable

Associated Types

type Mutable String
Instance details Defined in Foundation.Collection.Buildable type Mutable String = MutableString
type Step String
Instance details Defined in Foundation.Collection.Buildable type Step String = Word8

Methods

append :: forall (prim :: Type -> Type) err. PrimMonad prim => Element String -> Builder String (Mutable String) (Step String) prim err () Source #

build :: PrimMonad prim => Int -> Builder String (Mutable String) (Step String) prim err () -> prim (Either err String) Source #

Collection String Source #

Instance details

Defined in Foundation.Collection.Collection

Methods

null :: String -> Bool Source #

length :: String -> CountOf (Element String) Source #

elem :: (Eq a, a ~ Element String) => Element String -> String -> Bool Source #

notElem :: (Eq a, a ~ Element String) => Element String -> String -> Bool Source #

maximum :: (Ord a, a ~ Element String) => NonEmpty String -> Element String Source #

minimum :: (Ord a, a ~ Element String) => NonEmpty String -> Element String Source #

any :: (Element String -> Bool) -> String -> Bool Source #

all :: (Element String -> Bool) -> String -> Bool Source #

Copy String Source #

Instance details

Defined in Foundation.Collection.Copy

Methods

copy :: String -> String Source #

IndexedCollection String Source #

Instance details

Defined in Foundation.Collection.Indexed

Methods

(!) :: String -> Offset (Element String) -> Maybe (Element String) Source #

findIndex :: (Element String -> Bool) -> String -> Maybe (Offset (Element String)) Source #

InnerFunctor String Source #

Instance details

Defined in Foundation.Collection.InnerFunctor

Methods

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

Sequential String Source #

Instance details

Defined in Foundation.Collection.Sequential

Methods

take :: CountOf (Element String) -> String -> String Source #

revTake :: CountOf (Element String) -> String -> String Source #

drop :: CountOf (Element String) -> String -> String Source #

revDrop :: CountOf (Element String) -> String -> String Source #

splitAt :: CountOf (Element String) -> String -> (String, String) Source #

revSplitAt :: CountOf (Element String) -> String -> (String, String) Source #

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

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

breakEnd :: (Element String -> Bool) -> String -> (String, String) Source #

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

takeWhile :: (Element String -> Bool) -> String -> String Source #

dropWhile :: (Element String -> Bool) -> String -> String Source #

intersperse :: Element String -> String -> String Source #

intercalate :: Element String -> String -> Element String Source #

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

spanEnd :: (Element String -> Bool) -> String -> (String, String) Source #

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

partition :: (Element String -> Bool) -> String -> (String, String) Source #

reverse :: String -> String Source #

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

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

snoc :: String -> Element String -> String Source #

cons :: Element String -> String -> String Source #

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

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

singleton :: Element String -> String Source #

head :: NonEmpty String -> Element String Source #

last :: NonEmpty String -> Element String Source #

tail :: NonEmpty String -> String Source #

init :: NonEmpty String -> String Source #

replicate :: CountOf (Element String) -> Element String -> String Source #

isPrefixOf :: String -> String -> Bool Source #

isSuffixOf :: String -> String -> Bool Source #

isInfixOf :: String -> String -> Bool Source #

stripPrefix :: String -> String -> Maybe String Source #

stripSuffix :: String -> String -> Maybe String Source #

Zippable String Source #

Instance details

Defined in Foundation.Collection.Zippable

Methods

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

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

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

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 Source #

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 Source #

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 Source #

IsField String Source #

Instance details

Defined in Foundation.Format.CSV.Types

Methods

toField :: String -> Field Source #

fromField :: Field -> Either String String Source #

Hashable String Source #

Instance details

Defined in Foundation.Hashing.Hashable

Methods

hashMix :: Hasher st => String -> st -> st Source #

ParserSource String Source #

Instance details

Defined in Foundation.Parser

Associated Types

type Chunk String
Instance details Defined in Foundation.Parser type Chunk String = String

Methods

nullChunk :: String -> Chunk String -> Bool Source #

appendChunk :: String -> Chunk String -> String Source #

subChunk :: String -> Offset (Element String) -> CountOf (Element String) -> Chunk String Source #

spanChunk :: String -> Offset (Element String) -> (Element String -> Bool) -> (Chunk String, Offset (Element String)) Source #

Monoid String

Instance details

Defined in Basement.UTF8.Base

Methods

mempty :: String Source #

mappend :: String -> String -> String Source #

mconcat :: [String] -> String Source #

Semigroup String

Instance details

Defined in Basement.UTF8.Base

Methods

(<>) :: String -> String -> String Source #

sconcat :: NonEmpty String -> String Source #

stimes :: Integral b => b -> String -> String Source #

Data String

Instance details

Defined in Basement.UTF8.Base

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> String -> c String Source #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c String Source #

toConstr :: String -> Constr Source #

dataTypeOf :: String -> DataType Source #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c String) Source #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c String) Source #

gmapT :: (forall b. Data b => b -> b) -> String -> String Source #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> String -> r Source #

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> String -> r Source #

gmapQ :: (forall d. Data d => d -> u) -> String -> [u] Source #

gmapQi :: Int -> (forall d. Data d => d -> u) -> String -> u Source #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> String -> m String Source #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> String -> m String Source #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> String -> m String Source #

IsString String

Instance details

Defined in Basement.UTF8.Base

Methods

fromString :: String -> String Source #

IsList String

Instance details

Defined in Basement.UTF8.Base

Associated Types

type Item String
Instance details Defined in Basement.UTF8.Base type Item String = Char

Methods

fromList :: [Item String] -> String Source #

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

toList :: String -> [Item String] Source #

Show String

Instance details

Defined in Basement.UTF8.Base

Methods

showsPrec :: Int -> String -> ShowS Source #

show :: String -> String Source #

showList :: [String] -> ShowS Source #

Eq String

Instance details

Defined in Basement.UTF8.Base

Methods

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

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

Ord String

Instance details

Defined in Basement.UTF8.Base

Methods

compare :: String -> String -> Ordering Source #

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

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

(>) :: String -> String -> Bool Source #

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

max :: String -> String -> String Source #

min :: String -> String -> String Source #

From AsciiString String

Instance details

Defined in Basement.From

Methods

from :: AsciiString -> String

From String (UArray Word8)

Instance details

Defined in Basement.From

Methods

from :: String -> UArray Word8

Show (ParseError String) Source #

Instance details

Defined in Foundation.Parser

Methods

showsPrec :: Int -> ParseError String -> ShowS Source #

show :: ParseError String -> String Source #

showList :: [ParseError String] -> ShowS Source #

TryFrom (UArray Word8) String

Instance details

Defined in Basement.From

Methods

tryFrom :: UArray Word8 -> Maybe String

IsProperty (String, Bool) Source #

Instance details

Defined in Foundation.Check.Property

Methods

property :: (String, Bool) -> Property Source #

type Mutable String Source #

Instance details

Defined in Foundation.Collection.Buildable

type Mutable String = MutableString

type Step String Source #

Instance details

Defined in Foundation.Collection.Buildable

type Step String = Word8

type Element String Source #

Instance details

Defined in Foundation.Collection.Element

type Element String = Char

type Chunk String Source #

Instance details

Defined in Foundation.Parser

type Chunk String = String

type Item String

Instance details

Defined in Basement.UTF8.Base

type Item String = Char

data Encoding #

Constructors

ASCII7
UTF8
UTF16
UTF32
ISO_8859_1

Instances

Instances details

Data Encoding
Instance details Defined in Basement.String Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Encoding -> c Encoding Source # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Encoding Source # toConstr :: Encoding -> Constr Source # dataTypeOf :: Encoding -> DataType Source # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Encoding) Source # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Encoding) Source # gmapT :: (forall b. Data b => b -> b) -> Encoding -> Encoding Source # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Encoding -> r Source # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Encoding -> r Source # gmapQ :: (forall d. Data d => d -> u) -> Encoding -> [u] Source # gmapQi :: Int -> (forall d. Data d => d -> u) -> Encoding -> u Source # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Encoding -> m Encoding Source # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Encoding -> m Encoding Source # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Encoding -> m Encoding Source #
Bounded Encoding
Instance details Defined in Basement.String Methods minBound :: Encoding Source # maxBound :: Encoding Source #
Enum Encoding
Instance details Defined in Basement.String Methods succ :: Encoding -> Encoding Source # pred :: Encoding -> Encoding Source # toEnum :: Int -> Encoding Source # fromEnum :: Encoding -> Int Source # enumFrom :: Encoding -> [Encoding] Source # enumFromThen :: Encoding -> Encoding -> [Encoding] Source # enumFromTo :: Encoding -> Encoding -> [Encoding] Source # enumFromThenTo :: Encoding -> Encoding -> Encoding -> [Encoding] Source #
Show Encoding
Instance details Defined in Basement.String Methods showsPrec :: Int -> Encoding -> ShowS Source # show :: Encoding -> String Source # showList :: [Encoding] -> ShowS Source #
Eq Encoding
Instance details Defined in Basement.String Methods (==) :: Encoding -> Encoding -> Bool Source # (/=) :: Encoding -> Encoding -> Bool Source #
Ord Encoding
Instance details Defined in Basement.String Methods compare :: Encoding -> Encoding -> Ordering Source # (<) :: Encoding -> Encoding -> Bool Source # (<=) :: Encoding -> Encoding -> Bool Source # (>) :: Encoding -> Encoding -> Bool Source # (>=) :: Encoding -> Encoding -> Bool Source # max :: Encoding -> Encoding -> Encoding Source # min :: Encoding -> Encoding -> Encoding Source #

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

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

fromBytesUnsafe :: UArray Word8 -> String #

toBytes :: Encoding -> String -> UArray Word8 #

data ValidationFailure #

Constructors

InvalidHeader
InvalidContinuation
MissingByte
BuildingFailure

Instances

Instances details

Exception ValidationFailure
Instance details Defined in Basement.UTF8.Types Methods toException :: ValidationFailure -> SomeException Source # fromException :: SomeException -> Maybe ValidationFailure Source # displayException :: ValidationFailure -> String Source # backtraceDesired :: ValidationFailure -> Bool Source #
Show ValidationFailure
Instance details Defined in Basement.UTF8.Types Methods showsPrec :: Int -> ValidationFailure -> ShowS Source # show :: ValidationFailure -> String Source # showList :: [ValidationFailure] -> ShowS Source #
Eq ValidationFailure
Instance details Defined in Basement.UTF8.Types Methods (==) :: ValidationFailure -> ValidationFailure -> Bool Source # (/=) :: ValidationFailure -> ValidationFailure -> Bool Source #

lines :: String -> [String] #

words :: String -> [String] #

upper :: String -> String #

lower :: String -> String #

replace :: String -> String -> String -> String #

indices :: String -> String -> [Offset8] #

toBase64 :: String -> String #

toBase64URL :: Bool -> String -> String #

toBase64OpenBSD :: String -> String #

breakLine :: String -> Either Bool (String, String) #