Data.Bytes

Types

data Bytes

A slice of a ByteArray.

Instances

IsList Bytes

Defined in Data.Bytes.Types

Associated Types

type Item Bytes :: Type

Methods

fromList :: [Item Bytes] -> Bytes

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

toList :: Bytes -> [Item Bytes]

Eq Bytes

Defined in Data.Bytes.Types

Methods

(==) :: Bytes -> Bytes -> Bool

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

Ord Bytes

Defined in Data.Bytes.Types

Methods

compare :: Bytes -> Bytes -> Ordering

(<) :: Bytes -> Bytes -> Bool

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

(>) :: Bytes -> Bytes -> Bool

(>=) :: Bytes -> Bytes -> Bool

max :: Bytes -> Bytes -> Bytes

min :: Bytes -> Bytes -> Bytes

Show Bytes

Defined in Data.Bytes.Types

Methods

showsPrec :: Int -> Bytes -> ShowS

show :: Bytes -> String

showList :: [Bytes] -> ShowS

Semigroup Bytes

Defined in Data.Bytes.Types

Methods

(<>) :: Bytes -> Bytes -> Bytes

sconcat :: NonEmpty Bytes -> Bytes

stimes :: Integral b => b -> Bytes -> Bytes

type Item Bytes

Defined in Data.Bytes.Types

type Item Bytes = Word8

Properties

null :: Bytes -> Bool

Is the byte sequence empty?

length :: Bytes -> Int

The length of a slice of bytes.

Filtering

takeWhile :: (Word8 -> Bool) -> Bytes -> Bytes

Take bytes while the predicate is true.

dropWhile :: (Word8 -> Bool) -> Bytes -> Bytes

Drop bytes while the predicate is true.

takeWhileEnd :: (Word8 -> Bool) -> Bytes -> Bytes

O(n) takeWhileEnd p b returns the longest suffix of elements that satisfy predicate p.

dropWhileEnd :: (Word8 -> Bool) -> Bytes -> Bytes

O(n) dropWhileEnd p b returns the prefix remaining after dropping characters that satisfy the predicate p from the end of t.

Folds

foldl :: (a -> Word8 -> a) -> a -> Bytes -> a

Left fold over bytes, non-strict in the accumulator.

foldl' :: (a -> Word8 -> a) -> a -> Bytes -> a

Left fold over bytes, strict in the accumulator.

foldr :: (Word8 -> a -> a) -> a -> Bytes -> a

Right fold over bytes, non-strict in the accumulator.

foldr' :: (Word8 -> a -> a) -> a -> Bytes -> a

Right fold over bytes, strict in the accumulator.

Common Folds

elem :: Word8 -> Bytes -> Bool

Splitting

split :: Word8 -> Bytes -> [Bytes]

Break a byte sequence into pieces separated by the byte argument, consuming the delimiter. This function is a good producer for list fusion. It is common to immidiately consume the results of split with foldl', traverse_, foldlM, and being a good producer helps in this situation.

splitInit :: Word8 -> Bytes -> [Bytes]

Variant of split that drops the trailing element. This behaves correctly even if the byte sequence is empty.

splitFirst :: Word8 -> Bytes -> Maybe (Bytes, Bytes)

Split a byte sequence on the first occurrence of the target byte. The target is removed from the result. For example:

>>> splitOnce 0xA [0x1,0x2,0xA,0xB]
Just ([0x1,0x2],[0xB])

Counting

count :: Word8 -> Bytes -> Int

Count the number of times the byte appears in the sequence.

Prefix and Suffix

isPrefixOf :: Bytes -> Bytes -> Bool

Is the first argument a prefix of the second argument?

isSuffixOf :: Bytes -> Bytes -> Bool

Is the first argument a suffix of the second argument?

stripPrefix :: Bytes -> Bytes -> Maybe Bytes

O(n) Return the suffix of the second string if its prefix matches the entire first string.

stripOptionalPrefix :: Bytes -> Bytes -> Bytes

O(n) Return the suffix of the second string if its prefix matches the entire first string. Otherwise, return the second string unchanged.

stripSuffix :: Bytes -> Bytes -> Maybe Bytes

O(n) Return the prefix of the second string if its suffix matches the entire first string.

stripOptionalSuffix :: Bytes -> Bytes -> Bytes

O(n) Return the prefix of the second string if its suffix matches the entire first string. Otherwise, return the second string unchanged.

Unsafe Slicing

unsafeTake :: Int -> Bytes -> Bytes

Take the first n bytes from the argument. Precondition: n ≤ len

unsafeDrop :: Int -> Bytes -> Bytes

Drop the first n bytes from the argument. Precondition: n ≤ len

unsafeIndex :: Bytes -> Int -> Word8

Index into the byte sequence at the given position. This index must be less than the length.

Copying

copy

Arguments

:: PrimMonad m

=> MutableByteArray (PrimState m)

Destination

-> Int

Destination Offset

-> Bytes

Source

-> m ()

Copy the byte sequence into a mutable buffer. The buffer must have enough space to accomodate the byte sequence, but this this is not checked.

Pointers

pin :: Bytes -> Bytes

Yields a pinned byte sequence whose contents are identical to those of the original byte sequence. If the ByteArray backing the argument was already pinned, this simply aliases the argument and does not perform any copying.

contents :: Bytes -> Ptr Word8

Yields a pointer to the beginning of the byte sequence. It is only safe to call this on a Bytes backed by a pinned ByteArray.

touch :: PrimMonad m => Bytes -> m ()

Touch the byte array backing the byte sequence. This sometimes needed after calling contents so that the ByteArray does not get garbage collected.

Conversion

toByteArray :: Bytes -> ByteArray

Convert the sliced Bytes to an unsliced ByteArray. This reuses the array backing the sliced Bytes if the slicing metadata implies that all of the bytes are used. Otherwise, it makes a copy.

toByteArrayClone :: Bytes -> ByteArray

Variant of toByteArray that unconditionally makes a copy of the array backing the sliced Bytes even if the original array could be reused. Prefer toByteArray.

fromAsciiString :: String -> Bytes

Convert a String consisting of only characters in the ASCII block.

fromByteArray :: ByteArray -> Bytes

Create a slice of Bytes that spans the entire argument array.

toLatinString :: Bytes -> String

Interpret a byte sequence as text encoded by ISO-8859-1.