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.

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

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.