composewell/streamly
1
1
Fork 0
mirror of https://github.com/composewell/streamly.git synced 2024-10-05 23:37:43 +03:00
Code Issues Packages Projects Releases Wiki Activity

Add some notes in the immutable array module

Browse Source
This commit is contained in:
Adithya Kumar 2023-07-19 20:32:35 +05:30
parent aa023809e6
commit a9f0d38136
1 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
core/src/Streamly/Internal/Data/Array/Type.hs
View File

@ -110,6 +110,24 @@ import Streamly.Internal.System.IO (unsafeInlineIO, defaultChunkSize)
#include "DocTestDataArray.hs"
-------------------------------------------------------------------------------
-- Notes
-------------------------------------------------------------------------------
-- IMPORTANT:
-- We need to be careful while using unsafePerformIO when array creation is
-- involved.
--
-- * We need to make sure the unsafe IO line does not float out of the binding.
-- * The order of the IO actions should be sane. For example, `touch` after `f`.
--
-- Assume the unsafe IO action floats up. If it makes sense given this
-- assumption, it's probably OK to use usafe IO.
--
-- A general approach should be never to use unsafe IO where Array creation is
-- involved or touch is involved.
-------------------------------------------------------------------------------
-- Array Data Type
-------------------------------------------------------------------------------