Add a warning comment.

This commit is contained in:
Matus Tejiscak 2020-09-20 17:42:50 +02:00
parent b58cc433c8
commit 0a203f8f52

View File

@ -6,6 +6,15 @@ import public Data.List.Lazy
-- Backend-dependent string iteration type,
-- parameterised by the string that it iterates over.
--
-- Beware: the index is checked only up to definitional equality.
-- In theory, you could run `decEq` on two strings
-- with the same content but allocated in different memory locations
-- and use the obtained Refl to coerce iterators between them.
--
-- The strictly correct solution is to make the iterators independent
-- from the exact memory location of the string given to `uncons`.
-- (For example, byte offsets satisfy this requirement.)
export
data StringIterator : String -> Type where [external]