Data.Prim.Memory.ByteString

Documentation

newtype MByteString s

Mutable version of a ByteString

Constructors

MByteString ByteString

Instances

MemAlloc MByteString

Defined in Data.Prim.Memory.Internal

Associated Types

type FrozenMem MByteString = (fm :: Type)

Methods

getByteCountMutMem :: MonadPrim s m => MByteString s -> m (Count Word8)

allocMutMem :: (Prim e, MonadPrim s m) => Count e -> m (MByteString s)

thawMem :: MonadPrim s m => FrozenMem MByteString -> m (MByteString s)

freezeMutMem :: MonadPrim s m => MByteString s -> m (FrozenMem MByteString)

reallocMutMem :: (MonadPrim s m, Prim e) => MByteString s -> Count e -> m (MByteString s)

MemWrite MByteString

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

readByteOffMutMem :: (MonadPrim s m, Prim e) => MByteString s -> Off Word8 -> m e

writeOffMutMem :: (MonadPrim s m, Prim e) => MByteString s -> Off e -> e -> m ()

writeByteOffMutMem :: (MonadPrim s m, Prim e) => MByteString s -> Off Word8 -> e -> m ()

moveByteOffToMBytesMutMem :: forall s m e (p :: Pinned). (MonadPrim s m, Prim e) => MByteString s -> Off Word8 -> MBytes p s -> Off Word8 -> Count e -> m ()

moveByteOffToPtrMutMem :: (MonadPrim s m, Prim e) => MByteString s -> Off Word8 -> Ptr e -> Off Word8 -> Count e -> m ()

copyByteOffMem :: (MonadPrim s m, MemRead mr, Prim e) => mr -> Off Word8 -> MByteString s -> Off Word8 -> Count e -> m ()

moveByteOffMutMem :: (MonadPrim s m, MemWrite mw', Prim e) => mw' s -> Off Word8 -> MByteString s -> Off Word8 -> Count e -> m ()

setMutMem :: (MonadPrim s m, Prim e) => MByteString s -> Off e -> Count e -> e -> m ()

PtrAccess s (MByteString s)

Defined in Data.Prim.Memory.ForeignPtr

Methods

toForeignPtr :: MonadPrim s m => MByteString s -> m (ForeignPtr a)

withPtrAccess :: MonadPrim s m => MByteString s -> (Ptr a -> m b) -> m b

withNoHaltPtrAccess :: MonadUnliftPrim s m => MByteString s -> (Ptr a -> m b) -> m b

type FrozenMem MByteString

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

Semigroup Builder

Defined in Data.ByteString.Builder.Internal

Methods

(<>) :: Builder -> Builder -> Builder

sconcat :: NonEmpty Builder -> Builder

stimes :: Integral b => b -> Builder -> Builder

Monoid Builder

Defined in Data.ByteString.Builder.Internal

Methods

mempty :: Builder

mappend :: Builder -> Builder -> Builder

mconcat :: [Builder] -> Builder

toBuilderBytes :: Bytes p -> Builder

Convert Bytes into a bytestring Builder

fromBuilderBytes :: Builder -> Bytes 'Pin

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

Eq ByteString

Defined in Data.ByteString.Internal

Methods

(==) :: ByteString -> ByteString -> Bool

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

Data ByteString

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

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

Defined in Data.ByteString.Internal

Methods

readsPrec :: Int -> ReadS ByteString

readList :: ReadS [ByteString]

readPrec :: ReadPrec ByteString

readListPrec :: ReadPrec [ByteString]

Show ByteString

Defined in Data.ByteString.Internal

Methods

showsPrec :: Int -> ByteString -> ShowS

show :: ByteString -> String

showList :: [ByteString] -> ShowS

IsString ByteString

Defined in Data.ByteString.Internal

Methods

fromString :: String -> ByteString

Semigroup ByteString

Defined in Data.ByteString.Internal

Methods

(<>) :: ByteString -> ByteString -> ByteString

sconcat :: NonEmpty ByteString -> ByteString

stimes :: Integral b => b -> ByteString -> ByteString

Monoid ByteString

Defined in Data.ByteString.Internal

Methods

mempty :: ByteString

mappend :: ByteString -> ByteString -> ByteString

mconcat :: [ByteString] -> ByteString

NFData ByteString

Defined in Data.ByteString.Internal

Methods

rnf :: ByteString -> ()

MemRead ByteString

Defined in Data.Prim.Memory.Internal

Methods

isSameMem :: ByteString -> ByteString -> Bool

byteCountMem :: ByteString -> Count Word8

indexOffMem :: Prim e => ByteString -> Off e -> e

indexByteOffMem :: Prim e => ByteString -> Off Word8 -> e

copyByteOffToMBytesMem :: forall s m e (p :: Pinned). (MonadPrim s m, Prim e) => ByteString -> Off Word8 -> MBytes p s -> Off Word8 -> Count e -> m ()

copyByteOffToPtrMem :: (MonadPrim s m, Prim e) => ByteString -> Off Word8 -> Ptr e -> Off Word8 -> Count e -> m ()

compareByteOffToPtrMem :: (MonadPrim s m, Prim e) => ByteString -> Off Word8 -> Ptr e -> Off Word8 -> Count e -> m Ordering

compareByteOffToBytesMem :: forall e (p :: Pinned). Prim e => ByteString -> Off Word8 -> Bytes p -> Off Word8 -> Count e -> Ordering

compareByteOffMem :: (MemRead mr', Prim e) => mr' -> Off Word8 -> ByteString -> Off Word8 -> Count e -> Ordering

PtrAccess s ByteString

Read-only access, but immutability is not enforced.

Defined in Data.Prim.Memory.ForeignPtr

Methods

toForeignPtr :: MonadPrim s m => ByteString -> m (ForeignPtr a)

withPtrAccess :: MonadPrim s m => ByteString -> (Ptr a -> m b) -> m b

withNoHaltPtrAccess :: MonadUnliftPrim s m => ByteString -> (Ptr a -> m b) -> m b

toByteStringBytes :: Bytes 'Pin -> ByteString

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

Since: 0.1.0

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

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

fromLazyByteStringBytes :: ByteString -> Bytes 'Pin

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

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

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

Eq ShortByteString

Defined in Data.ByteString.Short.Internal

Methods

(==) :: ShortByteString -> ShortByteString -> Bool

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

Data ShortByteString

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

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

Defined in Data.ByteString.Short.Internal

Methods

readsPrec :: Int -> ReadS ShortByteString

readList :: ReadS [ShortByteString]

readPrec :: ReadPrec ShortByteString

readListPrec :: ReadPrec [ShortByteString]

Show ShortByteString

Defined in Data.ByteString.Short.Internal

Methods

showsPrec :: Int -> ShortByteString -> ShowS

show :: ShortByteString -> String

showList :: [ShortByteString] -> ShowS

IsString ShortByteString

Defined in Data.ByteString.Short.Internal

Methods

fromString :: String -> ShortByteString

Semigroup ShortByteString

Defined in Data.ByteString.Short.Internal

Methods

(<>) :: ShortByteString -> ShortByteString -> ShortByteString

sconcat :: NonEmpty ShortByteString -> ShortByteString

stimes :: Integral b => b -> ShortByteString -> ShortByteString

Monoid ShortByteString

Defined in Data.ByteString.Short.Internal

Methods

mempty :: ShortByteString

mappend :: ShortByteString -> ShortByteString -> ShortByteString

mconcat :: [ShortByteString] -> ShortByteString

NFData ShortByteString

Defined in Data.ByteString.Short.Internal

Methods

rnf :: ShortByteString -> ()

MemRead ShortByteString

Defined in Data.Prim.Memory.Internal

Methods

isSameMem :: ShortByteString -> ShortByteString -> Bool

byteCountMem :: ShortByteString -> Count Word8

indexOffMem :: Prim e => ShortByteString -> Off e -> e

indexByteOffMem :: Prim e => ShortByteString -> Off Word8 -> e

copyByteOffToMBytesMem :: forall s m e (p :: Pinned). (MonadPrim s m, Prim e) => ShortByteString -> Off Word8 -> MBytes p s -> Off Word8 -> Count e -> m ()

copyByteOffToPtrMem :: (MonadPrim s m, Prim e) => ShortByteString -> Off Word8 -> Ptr e -> Off Word8 -> Count e -> m ()

compareByteOffToPtrMem :: (MonadPrim s m, Prim e) => ShortByteString -> Off Word8 -> Ptr e -> Off Word8 -> Count e -> m Ordering

compareByteOffToBytesMem :: forall e (p :: Pinned). Prim e => ShortByteString -> Off Word8 -> Bytes p -> Off Word8 -> Count e -> Ordering

compareByteOffMem :: (MemRead mr', Prim e) => mr' -> Off Word8 -> ShortByteString -> Off Word8 -> Count e -> Ordering

toShortByteStringBytes :: Bytes p -> ShortByteString

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

Since: 0.1.0

fromShortByteStringBytes :: ShortByteString -> Bytes 'Inc

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

Since: 0.1.0

byteStringConvertError :: String -> a