Safe Haskell	None
Language	Haskell2010

B9.Text

Description

This module enables debugging all ByteString to Text to String conversions. This is an internal module.

Since: 0.5.67

Synopsis

data Text
type LazyText = Text
data ByteString
type LazyByteString = ByteString
class Textual a where
- renderToText :: HasCallStack => a -> Either String Text
- parseFromText :: HasCallStack => Text -> Either String a
writeTextFile :: (HasCallStack, MonadIO m) => FilePath -> Text -> m ()
unsafeRenderToText :: (Textual a, HasCallStack) => a -> Text
unsafeParseFromText :: (Textual a, HasCallStack) => Text -> a
parseFromTextWithErrorMessage :: (HasCallStack, Textual a) => String -> Text -> Either String a
encodeAsUtf8LazyByteString :: HasCallStack => String -> LazyByteString

Documentation

data Text #

A space efficient, packed, unboxed Unicode text type.

Instances

Hashable Text
Instance details Defined in Data.Hashable.Class Methods hashWithSalt :: Int -> Text -> Int # hash :: Text -> Int #
ToJSON Text
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: Text -> Value # toEncoding :: Text -> Encoding # toJSONList :: [Text] -> Value # toEncodingList :: [Text] -> Encoding #
KeyValue Object	Constructs a singleton `HashMap`. For calling functions that demand an `Object` for constructing objects. To be used in conjunction with `mconcat`. Prefer to use `object` where possible.
Instance details Defined in Data.Aeson.Types.ToJSON Methods (.=) :: ToJSON v => Text -> v -> Object #
KeyValue Pair
Instance details Defined in Data.Aeson.Types.ToJSON Methods (.=) :: ToJSON v => Text -> v -> Pair #
ToJSONKey Text
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSONKey :: ToJSONKeyFunction Text # toJSONKeyList :: ToJSONKeyFunction [Text] #
FromJSON Text
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser Text # parseJSONList :: Value -> Parser [Text] #
FromJSONKey Text
Instance details Defined in Data.Aeson.Types.FromJSON Methods fromJSONKey :: FromJSONKeyFunction Text # fromJSONKeyList :: FromJSONKeyFunction [Text] #
Chunk Text
Instance details Defined in Data.Attoparsec.Internal.Types Associated Types type ChunkElem Text :: Type # Methods nullChunk :: Text -> Bool # pappendChunk :: State Text -> Text -> State Text # atBufferEnd :: Text -> State Text -> Pos # bufferElemAt :: Text -> Pos -> State Text -> Maybe (ChunkElem Text, Int) # chunkElemToChar :: Text -> ChunkElem Text -> Char #
Ixed Text
Instance details Defined in Control.Lens.At Methods ix :: Index Text -> Traversal' Text (IxValue Text) #
SemiSequence Text
Instance details Defined in Data.Sequences Associated Types type Index Text :: Type # Methods intersperse :: Element Text -> Text -> Text # reverse :: Text -> Text # find :: (Element Text -> Bool) -> Text -> Maybe (Element Text) # sortBy :: (Element Text -> Element Text -> Ordering) -> Text -> Text # cons :: Element Text -> Text -> Text # snoc :: Text -> Element Text -> Text #
IsSequence Text
Instance details Defined in Data.Sequences Methods fromList :: [Element Text] -> Text # lengthIndex :: Text -> Index Text # break :: (Element Text -> Bool) -> Text -> (Text, Text) # span :: (Element Text -> Bool) -> Text -> (Text, Text) # dropWhile :: (Element Text -> Bool) -> Text -> Text # takeWhile :: (Element Text -> Bool) -> Text -> Text # splitAt :: Index Text -> Text -> (Text, Text) # unsafeSplitAt :: Index Text -> Text -> (Text, Text) # take :: Index Text -> Text -> Text # unsafeTake :: Index Text -> Text -> Text # drop :: Index Text -> Text -> Text # unsafeDrop :: Index Text -> Text -> Text # dropEnd :: Index Text -> Text -> Text # partition :: (Element Text -> Bool) -> Text -> (Text, Text) # uncons :: Text -> Maybe (Element Text, Text) # unsnoc :: Text -> Maybe (Text, Element Text) # filter :: (Element Text -> Bool) -> Text -> Text # filterM :: Monad m => (Element Text -> m Bool) -> Text -> m Text # replicate :: Index Text -> Element Text -> Text # replicateM :: Monad m => Index Text -> m (Element Text) -> m Text # groupBy :: (Element Text -> Element Text -> Bool) -> Text -> [Text] # groupAllOn :: Eq b => (Element Text -> b) -> Text -> [Text] # subsequences :: Text -> [Text] # permutations :: Text -> [Text] # tailEx :: Text -> Text # tailMay :: Text -> Maybe Text # initEx :: Text -> Text # initMay :: Text -> Maybe Text # unsafeTail :: Text -> Text # unsafeInit :: Text -> Text # index :: Text -> Index Text -> Maybe (Element Text) # indexEx :: Text -> Index Text -> Element Text # unsafeIndex :: Text -> Index Text -> Element Text # splitWhen :: (Element Text -> Bool) -> Text -> [Text] #
Textual Text
Instance details Defined in Data.Sequences Methods words :: Text -> [Text] # unwords :: (Element seq ~ Text, MonoFoldable seq) => seq -> Text # lines :: Text -> [Text] # unlines :: (Element seq ~ Text, MonoFoldable seq) => seq -> Text # toLower :: Text -> Text # toUpper :: Text -> Text # toCaseFold :: Text -> Text # breakWord :: Text -> (Text, Text) # breakLine :: Text -> (Text, Text) #
MonoFunctor Text
Instance details Defined in Data.MonoTraversable Methods omap :: (Element Text -> Element Text) -> Text -> Text #
MonoFoldable Text
Instance details Defined in Data.MonoTraversable Methods ofoldMap :: Monoid m => (Element Text -> m) -> Text -> m # ofoldr :: (Element Text -> b -> b) -> b -> Text -> b # ofoldl' :: (a -> Element Text -> a) -> a -> Text -> a # otoList :: Text -> [Element Text] # oall :: (Element Text -> Bool) -> Text -> Bool # oany :: (Element Text -> Bool) -> Text -> Bool # onull :: Text -> Bool # olength :: Text -> Int # olength64 :: Text -> Int64 # ocompareLength :: Integral i => Text -> i -> Ordering # otraverse_ :: Applicative f => (Element Text -> f b) -> Text -> f () # ofor_ :: Applicative f => Text -> (Element Text -> f b) -> f () # omapM_ :: Applicative m => (Element Text -> m ()) -> Text -> m () # oforM_ :: Applicative m => Text -> (Element Text -> m ()) -> m () # ofoldlM :: Monad m => (a -> Element Text -> m a) -> a -> Text -> m a # ofoldMap1Ex :: Semigroup m => (Element Text -> m) -> Text -> m # ofoldr1Ex :: (Element Text -> Element Text -> Element Text) -> Text -> Element Text # ofoldl1Ex' :: (Element Text -> Element Text -> Element Text) -> Text -> Element Text # headEx :: Text -> Element Text # lastEx :: Text -> Element Text # unsafeHead :: Text -> Element Text # unsafeLast :: Text -> Element Text # maximumByEx :: (Element Text -> Element Text -> Ordering) -> Text -> Element Text # minimumByEx :: (Element Text -> Element Text -> Ordering) -> Text -> Element Text # oelem :: Element Text -> Text -> Bool # onotElem :: Element Text -> Text -> Bool #
MonoTraversable Text
Instance details Defined in Data.MonoTraversable Methods otraverse :: Applicative f => (Element Text -> f (Element Text)) -> Text -> f Text # omapM :: Applicative m => (Element Text -> m (Element Text)) -> Text -> m Text #
MonoPointed Text
Instance details Defined in Data.MonoTraversable Methods opoint :: Element Text -> Text #
GrowingAppend Text
Instance details Defined in Data.MonoTraversable
PrettyVal Text
Instance details Defined in Text.Show.PrettyVal Methods prettyVal :: Text -> Value # listValue :: [Text] -> Value
Textual Text Source #
Instance details Defined in B9.Text Methods renderToText :: Text -> Either String Text Source # parseFromText :: Text -> Either String Text Source #
LazySequence Text Text
Instance details Defined in Data.Sequences Methods toChunks :: Text -> [Text0] # fromChunks :: [Text0] -> Text # toStrict :: Text -> Text0 # fromStrict :: Text0 -> Text #
Utf8 Text ByteString
Instance details Defined in Data.Sequences Methods encodeUtf8 :: Text -> ByteString # decodeUtf8 :: ByteString -> Text #
Monad m => Stream Text m Char
Instance details Defined in Text.Parsec.Prim Methods uncons :: Text -> m (Maybe (Char, Text)) #
FromPairs Value (DList Pair)
Instance details Defined in Data.Aeson.Types.ToJSON Methods fromPairs :: DList Pair -> Value
v ~ Value => KeyValuePair v (DList Pair)
Instance details Defined in Data.Aeson.Types.ToJSON Methods pair :: String -> v -> DList Pair
type State Text
Instance details Defined in Data.Attoparsec.Internal.Types type State Text = Buffer
type ChunkElem Text
Instance details Defined in Data.Attoparsec.Internal.Types type ChunkElem Text = Char
type Item Text
Instance details Defined in Data.Text type Item Text = Char
type Index Text
Instance details Defined in Control.Lens.At type Index Text = Int
type IxValue Text
Instance details Defined in Control.Lens.At type IxValue Text = Char
type Index Text
Instance details Defined in Data.Sequences type Index Text = Int
type Element Text
Instance details Defined in Data.MonoTraversable type Element Text = Char

type LazyText = Text Source #

Lazy texts.

A type alias to Text that can be used everywhere such that references don't need to be qualified with the complete module name everywere.

Since: 0.5.67

data ByteString #

A space-efficient representation of a Word8 vector, supporting many efficient operations.

A ByteString contains 8-bit bytes, or by using the operations from Data.ByteString.Char8 it can be interpreted as containing 8-bit characters.

Instances

Eq ByteString
Instance details Defined in Data.ByteString.Internal Methods (==) :: ByteString -> ByteString -> Bool # (/=) :: ByteString -> ByteString -> Bool #
Data ByteString
Instance details Defined in Data.ByteString.Internal Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ByteString -> c ByteString # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ByteString # toConstr :: ByteString -> Constr # dataTypeOf :: ByteString -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ByteString) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ByteString) # gmapT :: (forall b. Data b => b -> b) -> ByteString -> ByteString # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ByteString -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ByteString -> r # gmapQ :: (forall d. Data d => d -> u) -> ByteString -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> ByteString -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> ByteString -> m ByteString # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ByteString -> m ByteString # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ByteString -> m ByteString #
Ord ByteString
Instance details Defined in Data.ByteString.Internal Methods compare :: ByteString -> ByteString -> Ordering # (<) :: ByteString -> ByteString -> Bool # (<=) :: ByteString -> ByteString -> Bool # (>) :: ByteString -> ByteString -> Bool # (>=) :: ByteString -> ByteString -> Bool # max :: ByteString -> ByteString -> ByteString # min :: ByteString -> ByteString -> ByteString #
Read ByteString
Instance details Defined in Data.ByteString.Internal Methods readsPrec :: Int -> ReadS ByteString # readList :: ReadS [ByteString] # readPrec :: ReadPrec ByteString # readListPrec :: ReadPrec [ByteString] #
Show ByteString
Instance details Defined in Data.ByteString.Internal Methods showsPrec :: Int -> ByteString -> ShowS # show :: ByteString -> String # showList :: [ByteString] -> ShowS #
IsString ByteString
Instance details Defined in Data.ByteString.Internal Methods fromString :: String -> ByteString #
Semigroup ByteString
Instance details Defined in Data.ByteString.Internal Methods (<>) :: ByteString -> ByteString -> ByteString # sconcat :: NonEmpty ByteString -> ByteString # stimes :: Integral b => b -> ByteString -> ByteString #
Monoid ByteString
Instance details Defined in Data.ByteString.Internal Methods mempty :: ByteString # mappend :: ByteString -> ByteString -> ByteString # mconcat :: [ByteString] -> ByteString #
Hashable ByteString
Instance details Defined in Data.Hashable.Class Methods hashWithSalt :: Int -> ByteString -> Int # hash :: ByteString -> Int #
Chunk ByteString
Instance details Defined in Data.Attoparsec.Internal.Types Associated Types type ChunkElem ByteString :: Type # Methods nullChunk :: ByteString -> Bool # pappendChunk :: State ByteString -> ByteString -> State ByteString # atBufferEnd :: ByteString -> State ByteString -> Pos # bufferElemAt :: ByteString -> Pos -> State ByteString -> Maybe (ChunkElem ByteString, Int) # chunkElemToChar :: ByteString -> ChunkElem ByteString -> Char #
Binary ByteString
Instance details Defined in Data.Binary.Class Methods put :: ByteString -> Put # get :: Get ByteString # putList :: [ByteString] -> Put #
NFData ByteString
Instance details Defined in Data.ByteString.Internal Methods rnf :: ByteString -> () #
Ixed ByteString
Instance details Defined in Control.Lens.At Methods ix :: Index ByteString -> Traversal' ByteString (IxValue ByteString) #
SemiSequence ByteString
Instance details Defined in Data.Sequences Associated Types type Index ByteString :: Type # Methods intersperse :: Element ByteString -> ByteString -> ByteString # reverse :: ByteString -> ByteString # find :: (Element ByteString -> Bool) -> ByteString -> Maybe (Element ByteString) # sortBy :: (Element ByteString -> Element ByteString -> Ordering) -> ByteString -> ByteString # cons :: Element ByteString -> ByteString -> ByteString # snoc :: ByteString -> Element ByteString -> ByteString #
IsSequence ByteString
Instance details Defined in Data.Sequences Methods fromList :: [Element ByteString] -> ByteString # lengthIndex :: ByteString -> Index ByteString # break :: (Element ByteString -> Bool) -> ByteString -> (ByteString, ByteString) # span :: (Element ByteString -> Bool) -> ByteString -> (ByteString, ByteString) # dropWhile :: (Element ByteString -> Bool) -> ByteString -> ByteString # takeWhile :: (Element ByteString -> Bool) -> ByteString -> ByteString # splitAt :: Index ByteString -> ByteString -> (ByteString, ByteString) # unsafeSplitAt :: Index ByteString -> ByteString -> (ByteString, ByteString) # take :: Index ByteString -> ByteString -> ByteString # unsafeTake :: Index ByteString -> ByteString -> ByteString # drop :: Index ByteString -> ByteString -> ByteString # unsafeDrop :: Index ByteString -> ByteString -> ByteString # dropEnd :: Index ByteString -> ByteString -> ByteString # partition :: (Element ByteString -> Bool) -> ByteString -> (ByteString, ByteString) # uncons :: ByteString -> Maybe (Element ByteString, ByteString) # unsnoc :: ByteString -> Maybe (ByteString, Element ByteString) # filter :: (Element ByteString -> Bool) -> ByteString -> ByteString # filterM :: Monad m => (Element ByteString -> m Bool) -> ByteString -> m ByteString # replicate :: Index ByteString -> Element ByteString -> ByteString # replicateM :: Monad m => Index ByteString -> m (Element ByteString) -> m ByteString # groupBy :: (Element ByteString -> Element ByteString -> Bool) -> ByteString -> [ByteString] # groupAllOn :: Eq b => (Element ByteString -> b) -> ByteString -> [ByteString] # subsequences :: ByteString -> [ByteString] # permutations :: ByteString -> [ByteString] # tailEx :: ByteString -> ByteString # tailMay :: ByteString -> Maybe ByteString # initEx :: ByteString -> ByteString # initMay :: ByteString -> Maybe ByteString # unsafeTail :: ByteString -> ByteString # unsafeInit :: ByteString -> ByteString # index :: ByteString -> Index ByteString -> Maybe (Element ByteString) # indexEx :: ByteString -> Index ByteString -> Element ByteString # unsafeIndex :: ByteString -> Index ByteString -> Element ByteString # splitWhen :: (Element ByteString -> Bool) -> ByteString -> [ByteString] #
MonoFunctor ByteString
Instance details Defined in Data.MonoTraversable Methods omap :: (Element ByteString -> Element ByteString) -> ByteString -> ByteString #
MonoFoldable ByteString
Instance details Defined in Data.MonoTraversable Methods ofoldMap :: Monoid m => (Element ByteString -> m) -> ByteString -> m # ofoldr :: (Element ByteString -> b -> b) -> b -> ByteString -> b # ofoldl' :: (a -> Element ByteString -> a) -> a -> ByteString -> a # otoList :: ByteString -> [Element ByteString] # oall :: (Element ByteString -> Bool) -> ByteString -> Bool # oany :: (Element ByteString -> Bool) -> ByteString -> Bool # onull :: ByteString -> Bool # olength :: ByteString -> Int # olength64 :: ByteString -> Int64 # ocompareLength :: Integral i => ByteString -> i -> Ordering # otraverse_ :: Applicative f => (Element ByteString -> f b) -> ByteString -> f () # ofor_ :: Applicative f => ByteString -> (Element ByteString -> f b) -> f () # omapM_ :: Applicative m => (Element ByteString -> m ()) -> ByteString -> m () # oforM_ :: Applicative m => ByteString -> (Element ByteString -> m ()) -> m () # ofoldlM :: Monad m => (a -> Element ByteString -> m a) -> a -> ByteString -> m a # ofoldMap1Ex :: Semigroup m => (Element ByteString -> m) -> ByteString -> m # ofoldr1Ex :: (Element ByteString -> Element ByteString -> Element ByteString) -> ByteString -> Element ByteString # ofoldl1Ex' :: (Element ByteString -> Element ByteString -> Element ByteString) -> ByteString -> Element ByteString # headEx :: ByteString -> Element ByteString # lastEx :: ByteString -> Element ByteString # unsafeHead :: ByteString -> Element ByteString # unsafeLast :: ByteString -> Element ByteString # maximumByEx :: (Element ByteString -> Element ByteString -> Ordering) -> ByteString -> Element ByteString # minimumByEx :: (Element ByteString -> Element ByteString -> Ordering) -> ByteString -> Element ByteString # oelem :: Element ByteString -> ByteString -> Bool # onotElem :: Element ByteString -> ByteString -> Bool #
MonoTraversable ByteString
Instance details Defined in Data.MonoTraversable Methods otraverse :: Applicative f => (Element ByteString -> f (Element ByteString)) -> ByteString -> f ByteString # omapM :: Applicative m => (Element ByteString -> m (Element ByteString)) -> ByteString -> m ByteString #
MonoPointed ByteString
Instance details Defined in Data.MonoTraversable Methods opoint :: Element ByteString -> ByteString #
GrowingAppend ByteString
Instance details Defined in Data.MonoTraversable
CmdString ByteString
Instance details Defined in Development.Shake.Command Methods cmdString :: (Str, Str -> ByteString)
Textual ByteString Source #	Convert a `ByteString` with UTF-8 encoded string to `Text` Since: 0.5.67
Instance details Defined in B9.Text Methods renderToText :: ByteString -> Either String Text Source # parseFromText :: Text -> Either String ByteString Source #
LazySequence ByteString ByteString
Instance details Defined in Data.Sequences Methods toChunks :: ByteString -> [ByteString0] # fromChunks :: [ByteString0] -> ByteString # toStrict :: ByteString -> ByteString0 # fromStrict :: ByteString0 -> ByteString #
Utf8 Text ByteString
Instance details Defined in Data.Sequences Methods encodeUtf8 :: Text -> ByteString # decodeUtf8 :: ByteString -> Text #
Monad m => Stream ByteString m Char
Instance details Defined in Text.Parsec.Prim Methods uncons :: ByteString -> m (Maybe (Char, ByteString)) #
type State ByteString
Instance details Defined in Data.Attoparsec.Internal.Types type State ByteString = Buffer
type ChunkElem ByteString
Instance details Defined in Data.Attoparsec.Internal.Types type ChunkElem ByteString = Word8
type Index ByteString
Instance details Defined in Control.Lens.At type Index ByteString = Int
type IxValue ByteString
Instance details Defined in Control.Lens.At type IxValue ByteString = Word8
type Index ByteString
Instance details Defined in Data.Sequences type Index ByteString = Int
type Element ByteString
Instance details Defined in Data.MonoTraversable type Element ByteString = Word8

type LazyByteString = ByteString Source #

Lazy byte strings.

A type alias to ByteString that can be used everywhere such that references don't need to be qualified with the complete module name everywere.

Since: 0.5.67

class Textual a where Source #

A class for values that can be converted to/from Text.

Since: 0.5.67

Methods

renderToText :: HasCallStack => a -> Either String Text Source #

Convert a String to Text If an error occured, return Left with the error message.

Since: 0.5.67

parseFromText :: HasCallStack => Text -> Either String a Source #

Convert a Text to String

Since: 0.5.67

Instances

Textual String Source #
Instance details Defined in B9.Text Methods renderToText :: String -> Either String Text Source # parseFromText :: Text -> Either String String Source #
Textual ByteString Source #	Convert a `ByteString` with UTF-8 encoded string to `Text` Since: 0.5.67
Instance details Defined in B9.Text Methods renderToText :: ByteString -> Either String Text Source # parseFromText :: Text -> Either String ByteString Source #
Textual Text Source #
Instance details Defined in B9.Text Methods renderToText :: Text -> Either String Text Source # parseFromText :: Text -> Either String Text Source #
Textual LazyByteString Source #	Convert a `LazyByteString` with UTF-8 encoded string to `Text` Since: 0.5.67
Instance details Defined in B9.Text Methods renderToText :: LazyByteString -> Either String Text Source # parseFromText :: Text -> Either String LazyByteString Source #
Textual YamlObject Source #
Instance details Defined in B9.Artifact.Content.YamlObject Methods renderToText :: YamlObject -> Either String Text Source # parseFromText :: Text -> Either String YamlObject Source #
Textual ErlangPropList Source #
Instance details Defined in B9.Artifact.Content.ErlangPropList Methods renderToText :: ErlangPropList -> Either String Text Source # parseFromText :: Text -> Either String ErlangPropList Source #
Textual CloudConfigYaml Source #
Instance details Defined in B9.Artifact.Content.CloudConfigYaml Methods renderToText :: CloudConfigYaml -> Either String Text Source # parseFromText :: Text -> Either String CloudConfigYaml Source #

writeTextFile :: (HasCallStack, MonadIO m) => FilePath -> Text -> m () Source #

Render a Text to a file.

Since: 0.5.67

unsafeRenderToText :: (Textual a, HasCallStack) => a -> Text Source #

Render a Text via renderToText and throw a runtime exception when rendering fails.

Since: 0.5.67

unsafeParseFromText :: (Textual a, HasCallStack) => Text -> a Source #

Parse a Text via parseFromText and throw a runtime exception when parsing fails.

Since: 0.5.67

parseFromTextWithErrorMessage Source #

Arguments

:: (HasCallStack, Textual a)
=> String	An arbitrary string for error messages
-> Text
-> Either String a

Parse the given Text. -- Return Left errorMessage or Right a.

encodeAsUtf8LazyByteString :: HasCallStack => String -> LazyByteString Source #

Encode a String as UTF-8 encoded into a LazyByteString.

Since: 0.5.67