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.Text

Description

Synopsis

data Text = Text !Array !Int !Int
data MText s = MText !(MArray s) !Int !Int
data Array = Array {
- aBA :: ByteArray#
}
data MArray s = MArray {
- maBA :: MutableByteArray# s
}
fromArrayBytes :: Array -> Bytes 'Inc
toArrayBytes :: Bytes p -> Array
fromMArrayMBytes :: MArray s -> MBytes 'Inc s
toMArrayMBytes :: MBytes p s -> MArray s

Documentation

data Text #

A space efficient, packed, unboxed Unicode text type.

Constructors

Text !Array !Int !Int

Instances

Instances details

MemRead Text Source #

Instance details

Defined in Data.Prim.Memory.Internal

Methods

isSameMem :: Text -> Text -> Bool

byteCountMem :: Text -> Count Word8 Source #

indexOffMem :: Prim e => Text -> Off e -> e Source #

indexByteOffMem :: Prim e => Text -> Off Word8 -> e Source #

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

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

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

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

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

data MText s Source #

Mutable version of a Text

Constructors

MText !(MArray s) !Int !Int

data Array #

Immutable array type.

The Array constructor is exposed since text-1.1.1.3

Constructors

Array
Fields aBA :: ByteArray#

Instances

Instances details

MemRead Array Source #

Instance details

Defined in Data.Prim.Memory.Internal

Methods

isSameMem :: Array -> Array -> Bool

byteCountMem :: Array -> Count Word8 Source #

indexOffMem :: Prim e => Array -> Off e -> e Source #

indexByteOffMem :: Prim e => Array -> Off Word8 -> e Source #

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

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

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

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

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

data MArray s #

Mutable array type, for use in the ST monad.

The MArray constructor is exposed since text-1.1.1.3

Constructors

MArray
Fields maBA :: MutableByteArray# s

Instances

Instances details

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

fromArrayBytes :: Array -> Bytes 'Inc Source #

O(1) - Cast an immutable Array from text package to immutable Bytes

Since: 0.3.0

toArrayBytes :: Bytes p -> Array Source #

O(1) - Cast immutable Bytes to an immutable Array from text package

Since: 0.3.0

fromMArrayMBytes :: MArray s -> MBytes 'Inc s Source #

O(1) - Cast a mutable MArray from text package to mutable MBytes

Since: 0.3.0

toMArrayMBytes :: MBytes p s -> MArray s Source #

O(1) - Cast mutable MBytes to a mutable MArray from text package

Since: 0.3.0