License	BSD-style
Maintainer	Vincent Hanquez <vincent@snarc.org>
Stability	stable
Portability	Good
Safe Haskell	None
Language	Haskell2010

Data.ByteArray

Contents

ByteArray Classes
ByteArray built-in types
ByteArray methods

Description

Simple and efficient byte array types

This module should be imported qualified.

Synopsis

module Data.ByteArray.Types
data Bytes
data ScrubbedBytes
data MemView = MemView !(Ptr Word8) !Int
data View bytes
view :: ByteArrayAccess bytes => bytes -> Int -> Int -> View bytes
takeView :: ByteArrayAccess bytes => bytes -> Int -> View bytes
dropView :: ByteArrayAccess bytes => bytes -> Int -> View bytes
module Data.ByteArray.Methods

ByteArray Classes

module Data.ByteArray.Types

ByteArray built-in types

data Bytes Source #

Simplest Byte Array

Instances

Instances details

Eq Bytes Source #
Instance details Defined in Data.ByteArray.Bytes Methods (==) :: Bytes -> Bytes -> Bool Source # (/=) :: Bytes -> Bytes -> Bool Source #
Ord Bytes Source #
Instance details Defined in Data.ByteArray.Bytes Methods compare :: Bytes -> Bytes -> Ordering Source # (<) :: Bytes -> Bytes -> Bool Source # (<=) :: Bytes -> Bytes -> Bool Source # (>) :: Bytes -> Bytes -> Bool Source # (>=) :: Bytes -> Bytes -> Bool Source # max :: Bytes -> Bytes -> Bytes Source # min :: Bytes -> Bytes -> Bytes Source #
Show Bytes Source #
Instance details Defined in Data.ByteArray.Bytes Methods showsPrec :: Int -> Bytes -> ShowS Source # show :: Bytes -> String Source # showList :: [Bytes] -> ShowS Source #
Semigroup Bytes Source #
Instance details Defined in Data.ByteArray.Bytes Methods (<>) :: Bytes -> Bytes -> Bytes Source # sconcat :: NonEmpty Bytes -> Bytes Source # stimes :: Integral b => b -> Bytes -> Bytes Source #
Monoid Bytes Source #
Instance details Defined in Data.ByteArray.Bytes Methods mempty :: Bytes Source # mappend :: Bytes -> Bytes -> Bytes Source # mconcat :: [Bytes] -> Bytes Source #
NormalForm Bytes Source #
Instance details Defined in Data.ByteArray.Bytes Methods toNormalForm :: Bytes -> () Source #
NFData Bytes Source #
Instance details Defined in Data.ByteArray.Bytes Methods rnf :: Bytes -> () Source #
ByteArray Bytes Source #
Instance details Defined in Data.ByteArray.Bytes Methods allocRet :: Int -> (Ptr p -> IO a) -> IO (a, Bytes) Source #
ByteArrayAccess Bytes Source #
Instance details Defined in Data.ByteArray.Bytes Methods length :: Bytes -> Int Source # withByteArray :: Bytes -> (Ptr p -> IO a) -> IO a Source # copyByteArrayToPtr :: Bytes -> Ptr p -> IO () Source #

data ScrubbedBytes Source #

ScrubbedBytes is a memory chunk which have the properties of:

Being scrubbed after its goes out of scope.
A Show instance that doesn't actually show any content
A Eq instance that is constant time

Instances

Instances details

Eq ScrubbedBytes Source #
Instance details Defined in Data.ByteArray.ScrubbedBytes Methods (==) :: ScrubbedBytes -> ScrubbedBytes -> Bool Source # (/=) :: ScrubbedBytes -> ScrubbedBytes -> Bool Source #
Ord ScrubbedBytes Source #
Instance details Defined in Data.ByteArray.ScrubbedBytes Methods compare :: ScrubbedBytes -> ScrubbedBytes -> Ordering Source # (<) :: ScrubbedBytes -> ScrubbedBytes -> Bool Source # (<=) :: ScrubbedBytes -> ScrubbedBytes -> Bool Source # (>) :: ScrubbedBytes -> ScrubbedBytes -> Bool Source # (>=) :: ScrubbedBytes -> ScrubbedBytes -> Bool Source # max :: ScrubbedBytes -> ScrubbedBytes -> ScrubbedBytes Source # min :: ScrubbedBytes -> ScrubbedBytes -> ScrubbedBytes Source #
Show ScrubbedBytes Source #
Instance details Defined in Data.ByteArray.ScrubbedBytes Methods showsPrec :: Int -> ScrubbedBytes -> ShowS Source # show :: ScrubbedBytes -> String Source # showList :: [ScrubbedBytes] -> ShowS Source #
IsString ScrubbedBytes Source #
Instance details Defined in Data.ByteArray.ScrubbedBytes Methods fromString :: String -> ScrubbedBytes Source #
Semigroup ScrubbedBytes Source #
Instance details Defined in Data.ByteArray.ScrubbedBytes Methods (<>) :: ScrubbedBytes -> ScrubbedBytes -> ScrubbedBytes Source # sconcat :: NonEmpty ScrubbedBytes -> ScrubbedBytes Source # stimes :: Integral b => b -> ScrubbedBytes -> ScrubbedBytes Source #
Monoid ScrubbedBytes Source #
Instance details Defined in Data.ByteArray.ScrubbedBytes Methods mempty :: ScrubbedBytes Source # mappend :: ScrubbedBytes -> ScrubbedBytes -> ScrubbedBytes Source # mconcat :: [ScrubbedBytes] -> ScrubbedBytes Source #
NormalForm ScrubbedBytes Source #
Instance details Defined in Data.ByteArray.ScrubbedBytes Methods toNormalForm :: ScrubbedBytes -> () Source #
NFData ScrubbedBytes Source #
Instance details Defined in Data.ByteArray.ScrubbedBytes Methods rnf :: ScrubbedBytes -> () Source #
ByteArray ScrubbedBytes Source #
Instance details Defined in Data.ByteArray.ScrubbedBytes Methods allocRet :: Int -> (Ptr p -> IO a) -> IO (a, ScrubbedBytes) Source #
ByteArrayAccess ScrubbedBytes Source #
Instance details Defined in Data.ByteArray.ScrubbedBytes Methods length :: ScrubbedBytes -> Int Source # withByteArray :: ScrubbedBytes -> (Ptr p -> IO a) -> IO a Source # copyByteArrayToPtr :: ScrubbedBytes -> Ptr p -> IO () Source #

data MemView Source #

A simple abstraction to a piece of memory.

Do beware that garbage collection related to piece of memory could be triggered before this is used.

Only use with the appropriate handler has been used (e.g. withForeignPtr on ForeignPtr)

Constructors

MemView !(Ptr Word8) !Int

Instances

Instances details

Eq MemView Source #
Instance details Defined in Data.ByteArray.MemView Methods (==) :: MemView -> MemView -> Bool Source # (/=) :: MemView -> MemView -> Bool Source #
Show MemView Source #
Instance details Defined in Data.ByteArray.MemView Methods showsPrec :: Int -> MemView -> ShowS Source # show :: MemView -> String Source # showList :: [MemView] -> ShowS Source #
ByteArrayAccess MemView Source #
Instance details Defined in Data.ByteArray.MemView Methods length :: MemView -> Int Source # withByteArray :: MemView -> (Ptr p -> IO a) -> IO a Source # copyByteArrayToPtr :: MemView -> Ptr p -> IO () Source #

data View bytes Source #

a view on a given bytes

Equality test in constant time

Instances

Instances details

ByteArrayAccess bytes => Eq (View bytes) Source #
Instance details Defined in Data.ByteArray.View Methods (==) :: View bytes -> View bytes -> Bool Source # (/=) :: View bytes -> View bytes -> Bool Source #
ByteArrayAccess bytes => Ord (View bytes) Source #
Instance details Defined in Data.ByteArray.View Methods compare :: View bytes -> View bytes -> Ordering Source # (<) :: View bytes -> View bytes -> Bool Source # (<=) :: View bytes -> View bytes -> Bool Source # (>) :: View bytes -> View bytes -> Bool Source # (>=) :: View bytes -> View bytes -> Bool Source # max :: View bytes -> View bytes -> View bytes Source # min :: View bytes -> View bytes -> View bytes Source #
ByteArrayAccess bytes => Show (View bytes) Source #
Instance details Defined in Data.ByteArray.View Methods showsPrec :: Int -> View bytes -> ShowS Source # show :: View bytes -> String Source # showList :: [View bytes] -> ShowS Source #
ByteArrayAccess bytes => ByteArrayAccess (View bytes) Source #
Instance details Defined in Data.ByteArray.View Methods length :: View bytes -> Int Source # withByteArray :: View bytes -> (Ptr p -> IO a) -> IO a Source # copyByteArrayToPtr :: View bytes -> Ptr p -> IO () Source #

view Source #

Arguments

:: ByteArrayAccess bytes
=> bytes	the byte array we put a view on
-> Int	the offset to start the byte array on
-> Int	the size of the view
-> View bytes

create a view on a given bytearray

This function update the offset and the size in order to guarantee:

offset >= 0
size >= 0
offset < length
size =< length - offset

takeView Source #

Arguments

:: ByteArrayAccess bytes
=> bytes	byte aray
-> Int	size of the view
-> View bytes

create a view from the given bytearray

dropView Source #

Arguments

:: ByteArrayAccess bytes
=> bytes	byte array
-> Int	the number of bytes do dropped before creating the view
-> View bytes

create a view from the given byte array starting after having dropped the fist n bytes

ByteArray methods

module Data.ByteArray.Methods