Safe Haskell	None
Language	Haskell2010

Data.ByteArray.Builder.Unsafe

Contents

Types
Safe Functions

Synopsis

newtype Builder = Builder (forall s. MutableByteArray# s -> Int# -> Int# -> State# s -> (#State# s, Int##))
stringUtf8 :: String -> Builder
cstring :: CString -> Builder

Types

newtype Builder Source #

An unmaterialized sequence of bytes that may be pasted into a mutable byte array.

Constructors

Builder (forall s. MutableByteArray# s -> Int# -> Int# -> State# s -> (#State# s, Int##))

This function takes a buffer, an offset, and a number of remaining bytes. It returns the new offset (should be greater than the old offset), or if there was not enough space left in buffer, it returns -1.

Instances

IsString Builder Source #
Instance details Defined in Data.ByteArray.Builder.Unsafe Methods fromString :: String -> Builder #
Semigroup Builder Source #
Instance details Defined in Data.ByteArray.Builder.Unsafe Methods (<>) :: Builder -> Builder -> Builder # sconcat :: NonEmpty Builder -> Builder # stimes :: Integral b => b -> Builder -> Builder #
Monoid Builder Source #
Instance details Defined in Data.ByteArray.Builder.Unsafe Methods mempty :: Builder # mappend :: Builder -> Builder -> Builder # mconcat :: [Builder] -> Builder #

Safe Functions

These functions are actually completely safe, but they are defined here because they are used by typeclass instances. Import them from Data.ByteArray.Builder instead.

stringUtf8 :: String -> Builder Source #

Create a builder from a cons-list of Char. These are be UTF-8 encoded.

cstring :: CString -> Builder Source #

Create a builder from a NUL-terminated CString. This ignores any textual encoding, copying bytes until NUL is reached.