Copyright	(c) Alexey Kuleshevich 2020
License	BSD3
Maintainer	Alexey Kuleshevich <alexey@kuleshevi.ch>
Stability	experimental
Portability	non-portable
Safe Haskell	None
Language	Haskell2010

Data.Prim.Memory.ByteString

Contents

Conversion
- ByteString
- ShortByteString

Description

Synopsis

newtype MByteString s = MByteString ByteString
data Builder
toBuilderBytes :: Bytes p -> Builder
fromBuilderBytes :: Builder -> Bytes 'Pin
data ByteString = PS !(ForeignPtr Word8) !Int !Int
toByteStringBytes :: Bytes 'Pin -> ByteString
fromByteStringBytes :: Typeable p => ByteString -> Bytes p
fromLazyByteStringBytes :: ByteString -> Bytes 'Pin
withPtrByteString :: MonadPrim s m => ByteString -> (Ptr a -> m b) -> m b
withNoHaltPtrByteString :: MonadUnliftPrim s m => ByteString -> (Ptr a -> m b) -> m b
data ShortByteString = SBS ByteArray#
toShortByteStringBytes :: Bytes p -> ShortByteString
fromShortByteStringBytes :: ShortByteString -> Bytes 'Inc
byteStringConvertError :: String -> a

Documentation

newtype MByteString s Source #

Mutable version of a ByteString

Constructors

MByteString ByteString

Instances

Instances details

MemAlloc MByteString Source #
Instance details Defined in Data.Prim.Memory.Internal Associated Types type FrozenMem MByteString = (fm :: Type) Source # Methods getByteCountMutMem :: MonadPrim s m => MByteString s -> m (Count Word8) Source # allocMutMem :: (Prim e, MonadPrim s m) => Count e -> m (MByteString s) Source # thawMem :: MonadPrim s m => FrozenMem MByteString -> m (MByteString s) Source # freezeMutMem :: MonadPrim s m => MByteString s -> m (FrozenMem MByteString) Source # reallocMutMem :: (MonadPrim s m, Prim e) => MByteString s -> Count e -> m (MByteString s) Source #
MemWrite MByteString Source #
Instance details Defined in Data.Prim.Memory.Internal Methods isSameMutMem :: MByteString s -> MByteString s -> Bool readOffMutMem :: (MonadPrim s m, Prim e) => MByteString s -> Off e -> m e Source # readByteOffMutMem :: (MonadPrim s m, Prim e) => MByteString s -> Off Word8 -> m e Source # writeOffMutMem :: (MonadPrim s m, Prim e) => MByteString s -> Off e -> e -> m () Source # writeByteOffMutMem :: (MonadPrim s m, Prim e) => MByteString s -> Off Word8 -> e -> m () Source # moveByteOffToMBytesMutMem :: forall s m e (p :: Pinned). (MonadPrim s m, Prim e) => MByteString s -> Off Word8 -> MBytes p s -> Off Word8 -> Count e -> m () Source # moveByteOffToPtrMutMem :: (MonadPrim s m, Prim e) => MByteString s -> Off Word8 -> Ptr e -> Off Word8 -> Count e -> m () Source # copyByteOffMem :: (MonadPrim s m, MemRead mr, Prim e) => mr -> Off Word8 -> MByteString s -> Off Word8 -> Count e -> m () Source # moveByteOffMutMem :: (MonadPrim s m, MemWrite mw', Prim e) => mw' s -> Off Word8 -> MByteString s -> Off Word8 -> Count e -> m () Source # setMutMem :: (MonadPrim s m, Prim e) => MByteString s -> Off e -> Count e -> e -> m () Source #
PtrAccess s (MByteString s) Source #
Instance details Defined in Data.Prim.Memory.ForeignPtr Methods toForeignPtr :: MonadPrim s m => MByteString s -> m (ForeignPtr a) Source # withPtrAccess :: MonadPrim s m => MByteString s -> (Ptr a -> m b) -> m b Source # withNoHaltPtrAccess :: MonadUnliftPrim s m => MByteString s -> (Ptr a -> m b) -> m b Source #
type FrozenMem MByteString Source #
Instance details Defined in Data.Prim.Memory.Internal type FrozenMem MByteString = ByteString

Conversion

data Builder #

Builders denote sequences of bytes. They are Monoids where mempty is the zero-length sequence and mappend is concatenation, which runs in O(1).

Instances

Instances details

Semigroup Builder
Instance details Defined in Data.ByteString.Builder.Internal Methods (<>) :: Builder -> Builder -> Builder # sconcat :: NonEmpty Builder -> Builder # stimes :: Integral b => b -> Builder -> Builder #
Monoid Builder
Instance details Defined in Data.ByteString.Builder.Internal Methods mempty :: Builder # mappend :: Builder -> Builder -> Builder # mconcat :: [Builder] -> Builder #

toBuilderBytes :: Bytes p -> Builder Source #

Convert Bytes into a bytestring Builder

fromBuilderBytes :: Builder -> Bytes 'Pin Source #

O(n) - Allocate Bytes and fill them using the supplied Builder

ByteString

data ByteString #

A space-efficient representation of a Word8 vector, supporting many efficient operations.

A ByteString contains 8-bit bytes, or by using the operations from Data.ByteString.Char8 it can be interpreted as containing 8-bit characters.

Constructors

PS !(ForeignPtr Word8) !Int !Int

Instances

Instances details

Eq ByteString
Instance details Defined in Data.ByteString.Internal Methods (==) :: ByteString -> ByteString -> Bool # (/=) :: ByteString -> ByteString -> Bool #
Data ByteString
Instance details Defined in Data.ByteString.Internal Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ByteString -> c ByteString # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ByteString # toConstr :: ByteString -> Constr # dataTypeOf :: ByteString -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ByteString) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ByteString) # gmapT :: (forall b. Data b => b -> b) -> ByteString -> ByteString # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ByteString -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ByteString -> r # gmapQ :: (forall d. Data d => d -> u) -> ByteString -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> ByteString -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> ByteString -> m ByteString # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ByteString -> m ByteString # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ByteString -> m ByteString #
Ord ByteString
Instance details Defined in Data.ByteString.Internal Methods compare :: ByteString -> ByteString -> Ordering # (<) :: ByteString -> ByteString -> Bool # (<=) :: ByteString -> ByteString -> Bool # (>) :: ByteString -> ByteString -> Bool # (>=) :: ByteString -> ByteString -> Bool # max :: ByteString -> ByteString -> ByteString # min :: ByteString -> ByteString -> ByteString #
Read ByteString
Instance details Defined in Data.ByteString.Internal Methods readsPrec :: Int -> ReadS ByteString # readList :: ReadS [ByteString] # readPrec :: ReadPrec ByteString # readListPrec :: ReadPrec [ByteString] #
Show ByteString
Instance details Defined in Data.ByteString.Internal Methods showsPrec :: Int -> ByteString -> ShowS # show :: ByteString -> String # showList :: [ByteString] -> ShowS #
IsString ByteString
Instance details Defined in Data.ByteString.Internal Methods fromString :: String -> ByteString #
Semigroup ByteString
Instance details Defined in Data.ByteString.Internal Methods (<>) :: ByteString -> ByteString -> ByteString # sconcat :: NonEmpty ByteString -> ByteString # stimes :: Integral b => b -> ByteString -> ByteString #
Monoid ByteString
Instance details Defined in Data.ByteString.Internal Methods mempty :: ByteString # mappend :: ByteString -> ByteString -> ByteString # mconcat :: [ByteString] -> ByteString #
NFData ByteString
Instance details Defined in Data.ByteString.Internal Methods rnf :: ByteString -> () #
MemRead ByteString Source #
Instance details Defined in Data.Prim.Memory.Internal Methods isSameMem :: ByteString -> ByteString -> Bool byteCountMem :: ByteString -> Count Word8 Source # indexOffMem :: Prim e => ByteString -> Off e -> e Source # indexByteOffMem :: Prim e => ByteString -> Off Word8 -> e Source # copyByteOffToMBytesMem :: forall s m e (p :: Pinned). (MonadPrim s m, Prim e) => ByteString -> Off Word8 -> MBytes p s -> Off Word8 -> Count e -> m () Source # copyByteOffToPtrMem :: (MonadPrim s m, Prim e) => ByteString -> Off Word8 -> Ptr e -> Off Word8 -> Count e -> m () Source # compareByteOffToPtrMem :: (MonadPrim s m, Prim e) => ByteString -> Off Word8 -> Ptr e -> Off Word8 -> Count e -> m Ordering Source # compareByteOffToBytesMem :: forall e (p :: Pinned). Prim e => ByteString -> Off Word8 -> Bytes p -> Off Word8 -> Count e -> Ordering Source # compareByteOffMem :: (MemRead mr', Prim e) => mr' -> Off Word8 -> ByteString -> Off Word8 -> Count e -> Ordering Source #
PtrAccess s ByteString Source #	Read-only access, but immutability is not enforced.
Instance details Defined in Data.Prim.Memory.ForeignPtr Methods toForeignPtr :: MonadPrim s m => ByteString -> m (ForeignPtr a) Source # withPtrAccess :: MonadPrim s m => ByteString -> (Ptr a -> m b) -> m b Source # withNoHaltPtrAccess :: MonadUnliftPrim s m => ByteString -> (Ptr a -> m b) -> m b Source #

toByteStringBytes :: Bytes 'Pin -> ByteString Source #

O(1) - Cast immutable Bytes to an immutable ByteString

Since: 0.1.0

fromByteStringBytes :: Typeable p => ByteString -> Bytes p Source #

O(n) - Convert a strict ByteString to Bytes.

fromLazyByteStringBytes :: ByteString -> Bytes 'Pin Source #

O(n) - Allocate Bytes and fill them with the contents of a lazy ByteString

withPtrByteString :: MonadPrim s m => ByteString -> (Ptr a -> m b) -> m b Source #

withNoHaltPtrByteString :: MonadUnliftPrim s m => ByteString -> (Ptr a -> m b) -> m b Source #

ShortByteString

data ShortByteString #

A compact representation of a Word8 vector.

It has a lower memory overhead than a ByteString and and does not contribute to heap fragmentation. It can be converted to or from a ByteString (at the cost of copying the string data). It supports very few other operations.

It is suitable for use as an internal representation for code that needs to keep many short strings in memory, but it should not be used as an interchange type. That is, it should not generally be used in public APIs. The ByteString type is usually more suitable for use in interfaces; it is more flexible and it supports a wide range of operations.

Constructors

SBS ByteArray#

Instances

Instances details

Eq ShortByteString
Instance details Defined in Data.ByteString.Short.Internal Methods (==) :: ShortByteString -> ShortByteString -> Bool # (/=) :: ShortByteString -> ShortByteString -> Bool #
Data ShortByteString
Instance details Defined in Data.ByteString.Short.Internal Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ShortByteString -> c ShortByteString # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ShortByteString # toConstr :: ShortByteString -> Constr # dataTypeOf :: ShortByteString -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ShortByteString) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ShortByteString) # gmapT :: (forall b. Data b => b -> b) -> ShortByteString -> ShortByteString # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ShortByteString -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ShortByteString -> r # gmapQ :: (forall d. Data d => d -> u) -> ShortByteString -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> ShortByteString -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> ShortByteString -> m ShortByteString # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ShortByteString -> m ShortByteString # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ShortByteString -> m ShortByteString #
Ord ShortByteString
Instance details Defined in Data.ByteString.Short.Internal Methods compare :: ShortByteString -> ShortByteString -> Ordering # (<) :: ShortByteString -> ShortByteString -> Bool # (<=) :: ShortByteString -> ShortByteString -> Bool # (>) :: ShortByteString -> ShortByteString -> Bool # (>=) :: ShortByteString -> ShortByteString -> Bool # max :: ShortByteString -> ShortByteString -> ShortByteString # min :: ShortByteString -> ShortByteString -> ShortByteString #
Read ShortByteString
Instance details Defined in Data.ByteString.Short.Internal Methods readsPrec :: Int -> ReadS ShortByteString # readList :: ReadS [ShortByteString] # readPrec :: ReadPrec ShortByteString # readListPrec :: ReadPrec [ShortByteString] #
Show ShortByteString
Instance details Defined in Data.ByteString.Short.Internal Methods showsPrec :: Int -> ShortByteString -> ShowS # show :: ShortByteString -> String # showList :: [ShortByteString] -> ShowS #
IsString ShortByteString
Instance details Defined in Data.ByteString.Short.Internal Methods fromString :: String -> ShortByteString #
Semigroup ShortByteString
Instance details Defined in Data.ByteString.Short.Internal Methods (<>) :: ShortByteString -> ShortByteString -> ShortByteString # sconcat :: NonEmpty ShortByteString -> ShortByteString # stimes :: Integral b => b -> ShortByteString -> ShortByteString #
Monoid ShortByteString
Instance details Defined in Data.ByteString.Short.Internal Methods mempty :: ShortByteString # mappend :: ShortByteString -> ShortByteString -> ShortByteString # mconcat :: [ShortByteString] -> ShortByteString #
NFData ShortByteString
Instance details Defined in Data.ByteString.Short.Internal Methods rnf :: ShortByteString -> () #
MemRead ShortByteString Source #
Instance details Defined in Data.Prim.Memory.Internal Methods isSameMem :: ShortByteString -> ShortByteString -> Bool byteCountMem :: ShortByteString -> Count Word8 Source # indexOffMem :: Prim e => ShortByteString -> Off e -> e Source # indexByteOffMem :: Prim e => ShortByteString -> Off Word8 -> e Source # copyByteOffToMBytesMem :: forall s m e (p :: Pinned). (MonadPrim s m, Prim e) => ShortByteString -> Off Word8 -> MBytes p s -> Off Word8 -> Count e -> m () Source # copyByteOffToPtrMem :: (MonadPrim s m, Prim e) => ShortByteString -> Off Word8 -> Ptr e -> Off Word8 -> Count e -> m () Source # compareByteOffToPtrMem :: (MonadPrim s m, Prim e) => ShortByteString -> Off Word8 -> Ptr e -> Off Word8 -> Count e -> m Ordering Source # compareByteOffToBytesMem :: forall e (p :: Pinned). Prim e => ShortByteString -> Off Word8 -> Bytes p -> Off Word8 -> Count e -> Ordering Source # compareByteOffMem :: (MemRead mr', Prim e) => mr' -> Off Word8 -> ShortByteString -> Off Word8 -> Count e -> Ordering Source #

toShortByteStringBytes :: Bytes p -> ShortByteString Source #

O(1) - Cast an immutable Bytes to an immutable ShortByteString

Since: 0.1.0

fromShortByteStringBytes :: ShortByteString -> Bytes 'Inc Source #

O(1) - Cast an immutable ShortByteString to an immutable Bytes

Since: 0.1.0

byteStringConvertError :: String -> a Source #