on master help sign in
Add warnings to unsafe modules
77fef5fBryan O'Sullivan
Data/Text/Internal/Builder.hs+4
@@ -11,6 +11,10 @@
11-- Stability : experimental
11-- Stability : experimental
12-- Portability : portable to Hugs and GHC
12-- Portability : portable to Hugs and GHC
13--
13--
14+-- /Warning/: this is an internal module, and does not have a stable
15+-- API or name. Functions in this module may not check or enforce
16+-- preconditions expected by public modules. Use at your own risk!
17+--
14-- Efficient construction of lazy @Text@ values. The principal
18-- Efficient construction of lazy @Text@ values. The principal
15-- operations on a @Builder@ are @singleton@, @fromText@, and
19-- operations on a @Builder@ are @singleton@, @fromText@, and
16-- @fromLazyText@, which construct new builders, and 'mappend', which
20-- @fromLazyText@, which construct new builders, and 'mappend', which
Data/Text/Internal/Builder/Functions.hs+4
@@ -9,6 +9,10 @@
9-- Stability : experimental
9-- Stability : experimental
10-- Portability : GHC
10-- Portability : GHC
11--
11--
12+-- /Warning/: this is an internal module, and does not have a stable
13+-- API or name. Functions in this module may not check or enforce
14+-- preconditions expected by public modules. Use at your own risk!
15+--
12-- Useful functions and combinators.
16-- Useful functions and combinators.
13
17
14module Data.Text.Internal.Builder.Functions
18module Data.Text.Internal.Builder.Functions
Data/Text/Internal/Builder/Int/Digits.hs+4
@@ -7,6 +7,10 @@
7-- Stability: experimental
7-- Stability: experimental
8-- Portability: portable
8-- Portability: portable
9--
9--
10+-- /Warning/: this is an internal module, and does not have a stable
11+-- API or name. Functions in this module may not check or enforce
12+-- preconditions expected by public modules. Use at your own risk!
13+--
10-- This module exists because the C preprocessor does things that we
14-- This module exists because the C preprocessor does things that we
11-- shall not speak of when confronted with Haskell multiline strings.
15-- shall not speak of when confronted with Haskell multiline strings.
12
16
Data/Text/Internal/Builder/RealFloat/Functions.hs+4
@@ -2,6 +2,10 @@
2-- Module: Data.Text.Internal.Builder.RealFloat.Functions
2-- Module: Data.Text.Internal.Builder.RealFloat.Functions
3-- Copyright: (c) The University of Glasgow 1994-2002
3-- Copyright: (c) The University of Glasgow 1994-2002
4-- License: see libraries/base/LICENSE
4-- License: see libraries/base/LICENSE
5+--
6+-- /Warning/: this is an internal module, and does not have a stable
7+-- API or name. Functions in this module may not check or enforce
8+-- preconditions expected by public modules. Use at your own risk!
5
9
6module Data.Text.Internal.Builder.RealFloat.Functions
10module Data.Text.Internal.Builder.RealFloat.Functions
7 (
11 (
Data/Text/Internal/Encoding/Fusion.hs+4
@@ -12,6 +12,10 @@
12-- Stability : experimental
12-- Stability : experimental
13-- Portability : portable
13-- Portability : portable
14--
14--
15+-- /Warning/: this is an internal module, and does not have a stable
16+-- API or name. Functions in this module may not check or enforce
17+-- preconditions expected by public modules. Use at your own risk!
18+--
15-- Fusible 'Stream'-oriented functions for converting between 'Text'
19-- Fusible 'Stream'-oriented functions for converting between 'Text'
16-- and several common encodings.
20-- and several common encodings.
17
21
Data/Text/Internal/Encoding/Fusion/Common.hs+3
@@ -13,6 +13,9 @@
13-- Stability : experimental
13-- Stability : experimental
14-- Portability : portable
14-- Portability : portable
15--
15--
16+-- /Warning/: this is an internal module, and does not have a stable
17+-- API or name. Use at your own risk!
18+--
16-- Fusible 'Stream'-oriented functions for converting between 'Text'
19-- Fusible 'Stream'-oriented functions for converting between 'Text'
17-- and several common encodings.
20-- and several common encodings.
18
21
Data/Text/Internal/Encoding/Utf16.hs+4
@@ -12,6 +12,10 @@
12-- Stability : experimental
12-- Stability : experimental
13-- Portability : GHC
13-- Portability : GHC
14--
14--
15+-- /Warning/: this is an internal module, and does not have a stable
16+-- API or name. Functions in this module may not check or enforce
17+-- preconditions expected by public modules. Use at your own risk!
18+--
15-- Basic UTF-16 validation and character manipulation.
19-- Basic UTF-16 validation and character manipulation.
16module Data.Text.Internal.Encoding.Utf16
20module Data.Text.Internal.Encoding.Utf16
17 (
21 (
Data/Text/Internal/Encoding/Utf32.hs+4
@@ -10,6 +10,10 @@
10-- Stability : experimental
10-- Stability : experimental
11-- Portability : portable
11-- Portability : portable
12--
12--
13+-- /Warning/: this is an internal module, and does not have a stable
14+-- API or name. Functions in this module may not check or enforce
15+-- preconditions expected by public modules. Use at your own risk!
16+--
13-- Basic UTF-32 validation.
17-- Basic UTF-32 validation.
14module Data.Text.Internal.Encoding.Utf32
18module Data.Text.Internal.Encoding.Utf32
15 (
19 (
Data/Text/Internal/Encoding/Utf8.hs+4
@@ -12,6 +12,10 @@
12-- Stability : experimental
12-- Stability : experimental
13-- Portability : GHC
13-- Portability : GHC
14--
14--
15+-- /Warning/: this is an internal module, and does not have a stable
16+-- API or name. Functions in this module may not check or enforce
17+-- preconditions expected by public modules. Use at your own risk!
18+--
15-- Basic UTF-8 validation and character manipulation.
19-- Basic UTF-8 validation and character manipulation.
16module Data.Text.Internal.Encoding.Utf8
20module Data.Text.Internal.Encoding.Utf8
17 (
21 (
Data/Text/Internal/Functions.hs+4
@@ -9,6 +9,10 @@
9-- Stability : experimental
9-- Stability : experimental
10-- Portability : GHC
10-- Portability : GHC
11--
11--
12+-- /Warning/: this is an internal module, and does not have a stable
13+-- API or name. Functions in this module may not check or enforce
14+-- preconditions expected by public modules. Use at your own risk!
15+--
12-- Useful functions.
16-- Useful functions.
13
17
14module Data.Text.Internal.Functions
18module Data.Text.Internal.Functions
Data/Text/Internal/Fusion.hs+4
@@ -12,6 +12,10 @@
12-- Stability : experimental
12-- Stability : experimental
13-- Portability : GHC
13-- Portability : GHC
14--
14--
15+-- /Warning/: this is an internal module, and does not have a stable
16+-- API or name. Functions in this module may not check or enforce
17+-- preconditions expected by public modules. Use at your own risk!
18+--
15-- Text manipulation functions represented as fusible operations over
19-- Text manipulation functions represented as fusible operations over
16-- streams.
20-- streams.
17module Data.Text.Internal.Fusion
21module Data.Text.Internal.Fusion
Data/Text/Internal/Fusion/Common.hs+4
@@ -9,6 +9,10 @@
9-- Stability : experimental
9-- Stability : experimental
10-- Portability : GHC
10-- Portability : GHC
11--
11--
12+-- /Warning/: this is an internal module, and does not have a stable
13+-- API or name. Functions in this module may not check or enforce
14+-- preconditions expected by public modules. Use at your own risk!
15+--
12-- Common stream fusion functionality for text.
16-- Common stream fusion functionality for text.
13
17
14module Data.Text.Internal.Fusion.Common
18module Data.Text.Internal.Fusion.Common
Data/Text/Internal/Fusion/Size.hs+4
@@ -11,6 +11,10 @@
11-- Stability : experimental
11-- Stability : experimental
12-- Portability : portable
12-- Portability : portable
13--
13--
14+-- /Warning/: this is an internal module, and does not have a stable
15+-- API or name. Functions in this module may not check or enforce
16+-- preconditions expected by public modules. Use at your own risk!
17+--
14-- Size hints.
18-- Size hints.
15
19
16module Data.Text.Internal.Fusion.Size
20module Data.Text.Internal.Fusion.Size
Data/Text/Internal/Fusion/Types.hs+4
@@ -12,6 +12,10 @@
12-- Stability : experimental
12-- Stability : experimental
13-- Portability : GHC
13-- Portability : GHC
14--
14--
15+-- /Warning/: this is an internal module, and does not have a stable
16+-- API or name. Functions in this module may not check or enforce
17+-- preconditions expected by public modules. Use at your own risk!
18+--
15-- Core stream fusion functionality for text.
19-- Core stream fusion functionality for text.
16
20
17module Data.Text.Internal.Fusion.Types
21module Data.Text.Internal.Fusion.Types
Data/Text/Internal/IO.hs+4
@@ -8,6 +8,10 @@
8-- Stability : experimental
8-- Stability : experimental
9-- Portability : GHC
9-- Portability : GHC
10--
10--
11+-- /Warning/: this is an internal module, and does not have a stable
12+-- API or name. Functions in this module may not check or enforce
13+-- preconditions expected by public modules. Use at your own risk!
14+--
11-- Low-level support for text I\/O.
15-- Low-level support for text I\/O.
12
16
13module Data.Text.Internal.IO
17module Data.Text.Internal.IO
Data/Text/Internal/Lazy.hs+4−4
@@ -9,13 +9,13 @@
9-- Stability : experimental
9-- Stability : experimental
10-- Portability : GHC
10-- Portability : GHC
11--
11--
12+-- /Warning/: this is an internal module, and does not have a stable
13+-- API or name. Functions in this module may not check or enforce
14+-- preconditions expected by public modules. Use at your own risk!
15+--
12-- A module containing private 'Text' internals. This exposes the
16-- A module containing private 'Text' internals. This exposes the
13-- 'Text' representation and low level construction functions.
17-- 'Text' representation and low level construction functions.
14-- Modules which extend the 'Text' system may need to use this module.
18-- Modules which extend the 'Text' system may need to use this module.
15−--
16−-- You should not use this module unless you are determined to monkey
17−-- with the internals, as the functions here do just about nothing to
18−-- preserve data invariants. You have been warned!
19
19
20module Data.Text.Internal.Lazy
20module Data.Text.Internal.Lazy
21 (
21 (
Data/Text/Internal/Lazy/Encoding/Fusion.hs+4
@@ -10,6 +10,10 @@
10-- Stability : experimental
10-- Stability : experimental
11-- Portability : portable
11-- Portability : portable
12--
12--
13+-- /Warning/: this is an internal module, and does not have a stable
14+-- API or name. Functions in this module may not check or enforce
15+-- preconditions expected by public modules. Use at your own risk!
16+--
13-- Fusible 'Stream'-oriented functions for converting between lazy
17-- Fusible 'Stream'-oriented functions for converting between lazy
14-- 'Text' and several common encodings.
18-- 'Text' and several common encodings.
15
19
Data/Text/Internal/Lazy/Fusion.hs+4
@@ -9,6 +9,10 @@
9-- Stability : experimental
9-- Stability : experimental
10-- Portability : GHC
10-- Portability : GHC
11--
11--
12+-- /Warning/: this is an internal module, and does not have a stable
13+-- API or name. Functions in this module may not check or enforce
14+-- preconditions expected by public modules. Use at your own risk!
15+--
12-- Core stream fusion functionality for text.
16-- Core stream fusion functionality for text.
13
17
14module Data.Text.Internal.Lazy.Fusion
18module Data.Text.Internal.Lazy.Fusion
Data/Text/Internal/Lazy/Search.hs+4
@@ -10,6 +10,10 @@
10-- Stability : experimental
10-- Stability : experimental
11-- Portability : GHC
11-- Portability : GHC
12--
12--
13+-- /Warning/: this is an internal module, and does not have a stable
14+-- API or name. Functions in this module may not check or enforce
15+-- preconditions expected by public modules. Use at your own risk!
16+--
13-- Fast substring search for lazy 'Text', based on work by Boyer,
17-- Fast substring search for lazy 'Text', based on work by Boyer,
14-- Moore, Horspool, Sunday, and Lundh. Adapted from the strict
18-- Moore, Horspool, Sunday, and Lundh. Adapted from the strict
15-- implementation.
19-- implementation.
Data/Text/Internal/Unsafe.hs+6−2
@@ -8,8 +8,12 @@
8-- Stability : experimental
8-- Stability : experimental
9-- Portability : portable
9-- Portability : portable
10--
10--
11+-- /Warning/: this is an internal module, and does not have a stable
12+-- API or name. Functions in this module may not check or enforce
13+-- preconditions expected by public modules. Use at your own risk!
14+--
11−-- A module containing unsafe operations, for very very careful use in
15+-- A module containing /unsafe/ operations, for /very very careful/ use
12−-- heavily tested code.
16+-- in /heavily tested/ code.
13module Data.Text.Internal.Unsafe
17module Data.Text.Internal.Unsafe
14 (
18 (
15 inlineInterleaveST
19 inlineInterleaveST
Data/Text/Internal/Unsafe/Char.hs+4
@@ -12,6 +12,10 @@
12-- Stability : experimental
12-- Stability : experimental
13-- Portability : GHC
13-- Portability : GHC
14--
14--
15+-- /Warning/: this is an internal module, and does not have a stable
16+-- API or name. Functions in this module may not check or enforce
17+-- preconditions expected by public modules. Use at your own risk!
18+--
15-- Fast character manipulation functions.
19-- Fast character manipulation functions.
16module Data.Text.Internal.Unsafe.Char
20module Data.Text.Internal.Unsafe.Char
17 (
21 (
Data/Text/Internal/Unsafe/Shift.hs+4
@@ -10,6 +10,10 @@
10-- Stability : experimental
10-- Stability : experimental
11-- Portability : GHC
11-- Portability : GHC
12--
12--
13+-- /Warning/: this is an internal module, and does not have a stable
14+-- API or name. Functions in this module may not check or enforce
15+-- preconditions expected by public modules. Use at your own risk!
16+--
13-- Fast, unchecked bit shifting functions.
17-- Fast, unchecked bit shifting functions.
14
18
15module Data.Text.Internal.Unsafe.Shift
19module Data.Text.Internal.Unsafe.Shift