Binrep.Type.Text

Documentation

data Encoding

Character encoding.

Byte-oriented encodings like ASCII and UTF-8 don't need to worry about endianness. For UTF-16 and UTF-32, the designers decided to allow different endiannesses, rather than saying "codepoints must be X-endian".

Constructors

UTF8

UTF16 Endianness

UTF32 Endianness

ASCII

7-bit

SJIS

Instances

Data Encoding

Defined in Binrep.Type.Text

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 :: forall r r'. (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

Generic Encoding

Defined in Binrep.Type.Text

Associated Types

type Rep Encoding :: Type -> Type

Methods

from :: Encoding -> Rep Encoding x

to :: Rep Encoding x -> Encoding

Show Encoding

Defined in Binrep.Type.Text

Methods

showsPrec :: Int -> Encoding -> ShowS

show :: Encoding -> String

showList :: [Encoding] -> ShowS

Eq Encoding

Defined in Binrep.Type.Text

Methods

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

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

Predicate 'ASCII Text

Text must be validated if you want to permit 7-bit ASCII only.

Defined in Binrep.Type.Text

Methods

validate :: Proxy 'ASCII -> Text -> Maybe RefineException

Predicate 'SJIS Text

TODO Unsafely assume all Texts are valid Shift-JIS.

Defined in Binrep.Type.Text

Methods

validate :: Proxy 'SJIS -> Text -> Maybe RefineException

Predicate 'UTF8 Text

Any Text value is always valid UTF-8.

Defined in Binrep.Type.Text

Methods

validate :: Proxy 'UTF8 -> Text -> Maybe RefineException

Typeable e => Predicate ('UTF16 e :: Encoding) Text

Any Text value is always valid UTF-16.

Defined in Binrep.Type.Text

Methods

validate :: Proxy ('UTF16 e) -> Text -> Maybe RefineException

Typeable e => Predicate ('UTF32 e :: Encoding) Text

Any Text value is always valid UTF-32.

Defined in Binrep.Type.Text

Methods

validate :: Proxy ('UTF32 e) -> Text -> Maybe RefineException

type Rep Encoding

Defined in Binrep.Type.Text

type Rep Encoding = D1 ('MetaData "Encoding" "Binrep.Type.Text" "binrep-0.3.1-inplace" 'False) ((C1 ('MetaCons "UTF8" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "UTF16" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Endianness))) :+: (C1 ('MetaCons "UTF32" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Endianness)) :+: (C1 ('MetaCons "ASCII" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "SJIS" 'PrefixI 'False) (U1 :: Type -> Type))))

type AsText (enc :: Encoding) = Refined enc Text

A string of a given encoding, stored in the Text type.

class Encode (enc :: Encoding)

Bytestring encoders for text validated for a given encoding.

Minimal complete definition

encode'

Instances

Encode 'ASCII

ASCII is a subset of UTF-8, so valid ASCII is valid UTF-8, so this is safe.

Defined in Binrep.Type.Text

Methods

encode' :: Text -> Bytes

Encode 'SJIS

Defined in Binrep.Type.Text

Methods

encode' :: Text -> Bytes

Encode 'UTF8

Defined in Binrep.Type.Text

Methods

encode' :: Text -> Bytes

Encode ('UTF16 'BE)

Defined in Binrep.Type.Text

Methods

encode' :: Text -> Bytes

Encode ('UTF16 'LE)

Defined in Binrep.Type.Text

Methods

encode' :: Text -> Bytes

Encode ('UTF32 'BE)

Defined in Binrep.Type.Text

Methods

encode' :: Text -> Bytes

Encode ('UTF32 'LE)

Defined in Binrep.Type.Text

Methods

encode' :: Text -> Bytes

encode :: forall enc. Encode enc => AsText enc -> Bytes

Encode some validated text.

class Decode (enc :: Encoding) where

Methods

decode :: Bytes -> Either String (AsText enc)

Decode a ByteString to Text with an explicit encoding.

This is intended to be used with visible type applications.

Instances

Decode 'SJIS

Defined in Binrep.Type.Text

Methods

decode :: Bytes -> Either String (AsText 'SJIS)

Decode 'UTF8

Defined in Binrep.Type.Text

Methods

decode :: Bytes -> Either String (AsText 'UTF8)

Decode ('UTF16 'BE)

Defined in Binrep.Type.Text

Methods

decode :: Bytes -> Either String (AsText ('UTF16 'BE))

Decode ('UTF16 'LE)

Defined in Binrep.Type.Text

Methods

decode :: Bytes -> Either String (AsText ('UTF16 'LE))

Decode ('UTF32 'BE)

Defined in Binrep.Type.Text

Methods

decode :: Bytes -> Either String (AsText ('UTF32 'BE))

Decode ('UTF32 'LE)

Defined in Binrep.Type.Text

Methods

decode :: Bytes -> Either String (AsText ('UTF32 'LE))

encodeToRep :: forall (rep :: Rep) enc. (Encode enc, Predicate rep Bytes) => AsText enc -> Either RefineException (Refined rep Bytes)

Encode some text to a bytestring, asserting that the resulting value is valid for the requested bytestring representation.

This is intended to be used with visible type applications:

>>> let Right t = refine @'UTF8 (Text.pack "hi")
>>> :t t
t :: AsText 'UTF8
>>> let Right bs = encodeToRep @'C t
>>> :t bs
bs :: Refined 'C Bytes

decodeViaTextICU :: String -> ByteString -> IO (Either String Text)