Give MutableBuffer and it's instances a module of their own each.

Author: Dretch

src/Node/Buffer.purs

@@ -1,262 +1,40 @@
 -- | Mutable buffers and associated operations.
 module Node.Buffer
-  ( class MutableBuffer
-  , create
-  , freeze
-  , unsafeFreeze
-  , thaw
-  , unsafeThaw
-  , fromArray
-  , fromString
-  , fromArrayBuffer
-  , toArrayBuffer
-  , read
-  , readString
-  , toString
-  , write
-  , writeString
-  , toArray
-  , getAtOffset
-  , setAtOffset
-  , slice
-  , size
-  , concat
-  , concat'
-  , copy
-  , fill
-  , Buffer
-  , STBuffer
-  , runST
+  ( Buffer
   , module TypesExports
+  , module Class
   ) where
 
-import Prelude
-
-import Control.Monad.ST (ST, kind Region)
-import Control.Monad.ST as ST
-import Data.ArrayBuffer.Types (ArrayBuffer)
-import Data.Maybe (Maybe)
 import Effect (Effect)
-import Node.Buffer.Immutable (ImmutableBuffer)
-import Node.Buffer.Immutable as Immutable
-import Node.Buffer.Types (BufferValueType, Octet, Offset)
+import Node.Buffer.Class (class MutableBuffer)
+import Node.Buffer.Class (class MutableBuffer, concat, concat', copy, create, fill, freeze, fromArray, fromArrayBuffer, fromString, getAtOffset, read, readString, setAtOffset, size, slice, thaw, toArray, toArrayBuffer, toString, unsafeFreeze, unsafeThaw, write, writeString) as Class
+import Node.Buffer.Internal as Internal
 import Node.Buffer.Types (BufferValueType(..), Octet, Offset) as TypesExports
-import Node.Encoding (Encoding, encodingToNode)
-import Unsafe.Coerce (unsafeCoerce)
-
--- | A type class for mutable buffers `buf` where operations on those buffers are
--- | represented by a particular monadic effect type `m`.
-class Monad m <= MutableBuffer buf m | m -> buf, buf -> m where
-
-  -- | Creates a new buffer of the specified size.
-  create :: Int -> m buf
-
-  -- | Creates an immutable copy of a mutable buffer.
-  freeze :: buf -> m ImmutableBuffer
-
-  -- | O(1). Convert a mutable buffer to an immutable buffer, without copying. The
-  -- | mutable buffer must not be mutated afterwards.
-  unsafeFreeze :: buf -> m ImmutableBuffer
-
-  -- | Creates a mutable copy of an immutable buffer.
-  thaw :: ImmutableBuffer -> m buf
-
-  -- | O(1) Convert an immutable buffer to a mutable buffer, without copying. The
-  -- | input buffer must not be used afterward.
-  unsafeThaw :: ImmutableBuffer -> m buf
-
-  -- | Creates a new buffer from an array of octets, sized to match the array.
-  fromArray :: Array Octet -> m buf
-
-  -- | Creates a new buffer from a string with the specified encoding, sized to
-  -- | match the string.
-  fromString :: String -> Encoding -> m buf
-
-  -- | Creates a buffer view from a JS ArrayByffer without copying data.
-  fromArrayBuffer :: ArrayBuffer -> m buf
-
-  -- | Copies the data in the buffer to a new JS ArrayBuffer
-  toArrayBuffer :: buf -> m ArrayBuffer
-
-  -- | Reads a numeric value from a buffer at the specified offset.
-  read :: BufferValueType -> Offset -> buf -> m Int
-
-  -- | Reads a section of a buffer as a string with the specified encoding.
-  readString :: Encoding -> Offset -> Offset -> buf -> m String
-
-  -- | Reads the buffer as a string with the specified encoding.
-  toString :: Encoding -> buf -> m String
-
-  -- | Writes a numeric value to a buffer at the specified offset.
-  write :: BufferValueType -> Int -> Offset -> buf -> m Unit
-
-  -- | Writes octets from a string to a buffer at the specified offset. Multi-byte
-  -- | characters will not be written to the buffer if there is not enough capacity
-  -- | to write them fully. The number of bytes written is returned.
-  writeString :: Encoding -> Offset -> Int -> String -> buf -> m Int
-
-  -- | Creates an array of octets from a buffer's contents.
-  toArray :: buf -> m (Array Octet)
-
-  -- | Reads an octet from a buffer at the specified offset.
-  getAtOffset :: Offset -> buf -> m (Maybe Octet)
-
-  -- | Writes an octet in the buffer at the specified offset.
-  setAtOffset :: Octet -> Offset -> buf -> m Unit
-
-  -- | Creates a new buffer slice that acts like a window on the original buffer.
-  -- | Writing to the slice buffer updates the original buffer and vice-versa.
-  slice :: Offset -> Offset -> buf -> buf
-
-  -- | Returns the size of a buffer.
-  size :: buf -> m Int
-
-  -- | Concatenates a list of buffers.
-  concat :: Array buf -> m buf
-
-  -- | Concatenates a list of buffers, combining them into a new buffer of the
-  -- | specified length.
-  concat' :: Array buf -> Int -> m buf
-
-  -- | Copies a section of a source buffer into a target buffer at the specified
-  -- | offset, and returns the number of octets copied.
-  copy :: Offset -> Offset -> buf -> Offset -> buf -> m Int
-
-  -- | Fills a range in a buffer with the specified octet.
-  fill :: Octet -> Offset -> Offset -> buf -> m Unit
 
 -- | A reference to a mutable buffer for use with `Effect`
 foreign import data Buffer :: Type
 
--- | A reference to a mutable buffer for use with `ST`
--- |
--- | The type parameter represents the memory region which the buffer belongs to.
-foreign import data STBuffer :: Region -> Type
-
--- | Runs an effect creating an `STBuffer` then freezes the buffer and returns
--- | it, without unneccessary copying.
-runST :: (forall h. ST h (STBuffer h)) -> ImmutableBuffer
-runST st = ST.run (st >>= unsafeFreeze)
-
 instance mutableBufferEffect :: MutableBuffer Buffer Effect where
-  create = createImpl
-  freeze = copyAllImpl
-  unsafeFreeze = unsafeFreezeImpl
-  thaw = copyAllImpl
-  unsafeThaw = unsafeThawImpl
-  fromArray = fromArrayImpl
-  fromString = fromStringImpl
-  fromArrayBuffer = fromArrayBufferImpl
-  toArrayBuffer = toArrayBufferImpl
-  read = readImpl
-  readString = readStringImpl
-  toString = toStringImpl
-  write = writeImpl
-  writeString = writeStringImpl
-  toArray = toArrayImpl
-  getAtOffset = getAtOffsetImpl
-  setAtOffset = setAtOffsetImpl
-  slice = sliceImpl
-  size = sizeImpl
-  concat = concatImpl
-  concat' = concatImpl'
-  copy = copyImpl
-  fill = fillImpl
-
-instance mutableBufferST :: MutableBuffer (STBuffer h) (ST h) where
-  create = createImpl
-  freeze = copyAllImpl
-  unsafeFreeze = unsafeFreezeImpl
-  thaw = copyAllImpl
-  unsafeThaw = unsafeThawImpl
-  fromArray = fromArrayImpl
-  fromString = fromStringImpl
-  fromArrayBuffer = fromArrayBufferImpl
-  toArrayBuffer = toArrayBufferImpl
-  read = readImpl
-  readString = readStringImpl
-  toString = toStringImpl
-  write = writeImpl
-  writeString = writeStringImpl
-  toArray = toArrayImpl
-  getAtOffset = getAtOffsetImpl
-  setAtOffset = setAtOffsetImpl
-  slice = sliceImpl
-  size = sizeImpl
-  concat = concatImpl
-  concat' = concatImpl'
-  copy = copyImpl
-  fill = fillImpl
-
-unsafeFreezeImpl :: forall buf m. Monad m => buf -> m ImmutableBuffer
-unsafeFreezeImpl = pure <<< unsafeCoerce
-
-unsafeThawImpl :: forall buf m. Monad m => ImmutableBuffer -> m buf
-unsafeThawImpl = pure <<< unsafeCoerce
-
-usingFromImmutable :: forall buf m a. Monad m => (ImmutableBuffer -> a) -> buf -> m a
-usingFromImmutable f buf = f <$> unsafeFreezeImpl buf
-
-usingToImmutable :: forall buf m a. Monad m => (a -> ImmutableBuffer) -> a -> m buf
-usingToImmutable f x = unsafeThawImpl $ f x
-
-createImpl :: forall buf m. Monad m => Int -> m buf
-createImpl = usingToImmutable Immutable.create
-
-foreign import copyAllImpl :: forall a buf m. a -> m buf
-
-fromArrayImpl :: forall buf m. Monad m => Array Octet -> m buf
-fromArrayImpl = usingToImmutable Immutable.fromArray
-
-fromStringImpl :: forall buf m. Monad m => String -> Encoding -> m buf
-fromStringImpl s = usingToImmutable $ Immutable.fromString s
-
-fromArrayBufferImpl :: forall buf m. Monad m => ArrayBuffer -> m buf
-fromArrayBufferImpl = usingToImmutable Immutable.fromArrayBuffer
-
-toArrayBufferImpl :: forall buf m. Monad m => buf -> m ArrayBuffer
-toArrayBufferImpl = usingFromImmutable Immutable.toArrayBuffer
-
-readImpl :: forall buf m. Monad m => BufferValueType -> Offset -> buf -> m Int
-readImpl t o = usingFromImmutable $ Immutable.read t o
-
-readStringImpl :: forall buf m. Monad m => Encoding -> Offset -> Offset -> buf -> m String
-readStringImpl m o o' = usingFromImmutable $ Immutable.readString m o o'
-
-toStringImpl :: forall buf m. Monad m => Encoding -> buf -> m String
-toStringImpl m = usingFromImmutable $ Immutable.toString m
-
-writeImpl :: forall buf m. Monad m => BufferValueType -> Int -> Offset -> buf -> m Unit
-writeImpl = writeInternal <<< show
-
-foreign import writeInternal :: forall buf m. String -> Int -> Offset -> buf -> m Unit
-
-writeStringImpl :: forall buf m. Monad m => Encoding -> Offset -> Int -> String -> buf -> m Int
-writeStringImpl = writeStringInternal <<< encodingToNode
-
-foreign import writeStringInternal ::
-  forall buf m. String -> Offset -> Int -> String -> buf -> m Int
-
-toArrayImpl :: forall buf m. Monad m => buf -> m (Array Octet)
-toArrayImpl = usingFromImmutable Immutable.toArray
-
-getAtOffsetImpl :: forall buf m. Monad m => Offset -> buf -> m (Maybe Octet)
-getAtOffsetImpl o = usingFromImmutable $ Immutable.getAtOffset o
-
-foreign import setAtOffsetImpl :: forall buf m. Octet -> Offset -> buf -> m Unit
-
-sliceImpl :: forall buf. Offset -> Offset -> buf -> buf
-sliceImpl = unsafeCoerce Immutable.slice
-
-sizeImpl :: forall buf m. Monad m => buf -> m Int
-sizeImpl = usingFromImmutable Immutable.size
-
-concatImpl :: forall buf m. Array buf -> m buf
-concatImpl arrs = unsafeCoerce \_ -> Immutable.concat (unsafeCoerce arrs)
-
-concatImpl' :: forall buf m. Monad m => Array buf -> Int -> m buf
-concatImpl' arrs n = unsafeCoerce \_ -> Immutable.concat' (unsafeCoerce arrs) n
-
-foreign import copyImpl :: forall buf m. Offset -> Offset -> buf -> Offset -> buf -> m Int
-
-foreign import fillImpl :: forall buf m. Octet -> Offset -> Offset -> buf -> m Unit
+  create = Internal.create
+  freeze = Internal.copyAll
+  unsafeFreeze = Internal.unsafeFreeze
+  thaw = Internal.copyAll
+  unsafeThaw = Internal.unsafeThaw
+  fromArray = Internal.fromArray
+  fromString = Internal.fromString
+  fromArrayBuffer = Internal.fromArrayBuffer
+  toArrayBuffer = Internal.toArrayBuffer
+  read = Internal.read
+  readString = Internal.readString
+  toString = Internal.toString
+  write = Internal.write
+  writeString = Internal.writeString
+  toArray = Internal.toArray
+  getAtOffset = Internal.getAtOffset
+  setAtOffset = Internal.setAtOffset
+  slice = Internal.slice
+  size = Internal.size
+  concat = Internal.concat
+  concat' = Internal.concat'
+  copy = Internal.copy
+  fill = Internal.fill