18fbd5e · text · git.iko.soy

git.iko.soy/text

Add `@since 1.1.1.*` annotations

Also add note about when `Array`/`MArray` constructors were exposed (c.f. 9ea72a0457f3269a50c7867752f9bb19a0cdd69c)

commit18fbd5e59fa539a77fbc0e1740e2bee09f44cfa3 authorHerbert Valerio Riedel <hvr@gnu.org> dateSat 23 Dec 2017, 18:38 (9 years ago) parent8f9b765

4 files changed+14

compare with master

unifiedsplit

Data/Text.hs+4 Data/Text/Array.hs+4 Data/Text/Lazy.hs+4 Data/Text/Unsafe.hs+2

Data/Text.hs+4

@@ -1120,6 +1120,8 @@ iterN n t@(Text _arr _off len) = loop 0 0

11201120-- Examples:

11211121--

11221122-- > takeEnd 3 "foobar" == "bar"

1123+--

1124+-- @since 1.1.1.0

11231125takeEnd :: Int -> Text -> Text

11241126takeEnd n t@(Text arr off len)

11251127 | n <= 0 = empty

@@ -1159,6 +1161,8 @@ drop n t@(Text arr off len)

11591161-- Examples:

11601162--

11611163-- > dropEnd 3 "foobar" == "foo"

1164+--

1165+-- @since 1.1.1.0

11621166dropEnd :: Int -> Text -> Text

11631167dropEnd n t@(Text arr off len)

11641168 | n <= 0 = t

Data/Text/Array.hs+4

@@ -80,6 +80,8 @@ import GHC.Word (Word16(..))

8080import Prelude hiding (length, read)

8181

8282-- | Immutable array type.

83+--

84+-- The 'Array' constructor is exposed since @text-1.1.1.3@

8385data Array = Array {

8486 aBA :: ByteArray#

8587#if defined(ASSERTS)

@@ -88,6 +90,8 @@ data Array = Array {

8890 }

8991

9092-- | Mutable array type, for use in the ST monad.

93+--

94+-- The 'MArray' constructor is exposed since @text-1.1.1.3@

9195data MArray s = MArray {

9296 maBA :: MutableByteArray# s

9397#if defined(ASSERTS)

Data/Text/Lazy.hs+4

@@ -1073,6 +1073,8 @@ take i t0 = take' i t0

10731073-- Examples:

10741074--

10751075-- > takeEnd 3 "foobar" == "bar"

1076+--

1077+-- @since 1.1.1.0

10761078takeEnd :: Int64 -> Text -> Text

10771079takeEnd n t0

10781080 | n <= 0 = empty

@@ -1111,6 +1113,8 @@ drop i t0

11111113-- Examples:

11121114--

11131115-- > dropEnd 3 "foobar" == "foo"

1116+--

1117+-- @since 1.1.1.0

11141118dropEnd :: Int64 -> Text -> Text

11151119dropEnd n t0

11161120 | n <= 0 = t0

Data/Text/Unsafe.hs+2

@@ -98,6 +98,8 @@ reverseIter (Text arr off _len) i

9898-- | /O(1)/ Iterate one step backwards through a UTF-16 array,

9999-- returning the delta to add (i.e. a negative number) to give the

100100-- next offset to iterate at.

101+--

102+-- @since 1.1.1.0

101103reverseIter_ :: Text -> Int -> Int

102104reverseIter_ (Text arr off _len) i

103105 | m < 0xDC00 || m > 0xDFFF = -1