Safe Haskell	None
Language	Haskell2010

Data.Bytes

Contents

Types
Properties
Filtering
Folds
Equality
Unsafe Slicing
Conversion

Synopsis

data Bytes
null :: Bytes -> Bool
length :: Bytes -> Int
takeWhile :: (Word8 -> Bool) -> Bytes -> Bytes
dropWhile :: (Word8 -> Bool) -> Bytes -> Bytes
foldl :: (a -> Word8 -> a) -> a -> Bytes -> a
foldl' :: (a -> Word8 -> a) -> a -> Bytes -> a
foldr :: (Word8 -> a -> a) -> a -> Bytes -> a
foldr' :: (Word8 -> a -> a) -> a -> Bytes -> a
isPrefixOf :: Bytes -> Bytes -> Bool
isSuffixOf :: Bytes -> Bytes -> Bool
unsafeTake :: Int -> Bytes -> Bytes
unsafeDrop :: Int -> Bytes -> Bytes
toByteArray :: Bytes -> ByteArray
toByteArrayClone :: Bytes -> ByteArray
fromAsciiString :: String -> Bytes
fromByteArray :: ByteArray -> Bytes

Types

data Bytes Source #

A slice of a ByteArray.

Instances

IsList Bytes Source #
Instance details 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 Source #
Instance details Defined in Data.Bytes.Types Methods (==) :: Bytes -> Bytes -> Bool # (/=) :: Bytes -> Bytes -> Bool #
Ord Bytes Source #
Instance details 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 Source #
Instance details Defined in Data.Bytes.Types Methods showsPrec :: Int -> Bytes -> ShowS # show :: Bytes -> String # showList :: [Bytes] -> ShowS #
Semigroup Bytes Source #
Instance details Defined in Data.Bytes.Types Methods (<>) :: Bytes -> Bytes -> Bytes # sconcat :: NonEmpty Bytes -> Bytes # stimes :: Integral b => b -> Bytes -> Bytes #
type Item Bytes Source #
Instance details Defined in Data.Bytes.Types type Item Bytes = Word8

Properties

null :: Bytes -> Bool Source #

Is the byte sequence empty?

length :: Bytes -> Int Source #

The length of a slice of bytes.

Filtering

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

Take bytes while the predicate is true.

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

Drop bytes while the predicate is true.

Folds

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

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

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

Left fold over bytes, strict in the accumulator.

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

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

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

Right fold over bytes, strict in the accumulator.

Equality

isPrefixOf :: Bytes -> Bytes -> Bool Source #

Is the first argument a prefix of the second argument?

isSuffixOf :: Bytes -> Bytes -> Bool Source #

Is the first argument a suffix of the second argument?

Unsafe Slicing

unsafeTake :: Int -> Bytes -> Bytes Source #

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

unsafeDrop :: Int -> Bytes -> Bytes Source #

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

Conversion

toByteArray :: Bytes -> ByteArray Source #

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

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

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

fromByteArray :: ByteArray -> Bytes Source #

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