| Copyright | (c) The University of Glasgow 2001-2009 |
|---|---|
| License | BSD-style (see the file LICENSE) |
| Maintainer | libraries@haskell.org |
| Stability | stable |
| Portability | portable |
| Safe Haskell | Safe |
| Language | Haskell2010 |
Control.DeepSeq
Description
This module provides overloaded functions, such as deepseq and
rnf, for fully evaluating data structures (that is, evaluating to
"Normal Form").
A typical use is to prevent resource leaks in lazy IO programs, by forcing all characters from a file to be read. For example:
import System.IO
import Control.DeepSeq
import Control.Exception (evaluate)
readFile' :: FilePath -> IO String
readFile' fn = do
h <- openFile fn ReadMode
s <- hGetContents h
evaluate (rnf s)
hClose h
return sNote: The example above should rather be written in terms of
bracket to ensure releasing file-descriptors in
a timely matter (see the description of force for an example).
deepseq differs from seq as it traverses data structures deeply,
for example, seq will evaluate only to the first constructor in
the list:
> [1,2,undefined] `seq` 3 3
While deepseq will force evaluation of all the list elements:
> [1,2,undefined] `deepseq` 3 *** Exception: Prelude.undefined
Another common use is to ensure any exceptions hidden within lazy fields of a data structure do not leak outside the scope of the exception handler, or to force evaluation of a data structure in one thread, before passing to another thread (preventing work moving to the wrong threads).
Since: 1.1.0.0
Synopsis
- class NFData a where
- rnf :: a -> ()
- deepseq :: NFData a => a -> b -> b
- force :: NFData a => a -> a
- ($!!) :: NFData a => (a -> b) -> a -> b
- (<$!!>) :: (Monad m, NFData b) => (a -> b) -> m a -> m b
- rwhnf :: a -> ()
- class NFData1 f where
- liftRnf :: (a -> ()) -> f a -> ()
- rnf1 :: (NFData1 f, NFData a) => f a -> ()
- class NFData2 p where
- liftRnf2 :: (a -> ()) -> (b -> ()) -> p a b -> ()
- rnf2 :: (NFData2 p, NFData a, NFData b) => p a b -> ()
NFData class
A class of types that can be fully evaluated.
Since: 1.1.0.0
Minimal complete definition
Nothing
Methods
rnf should reduce its argument to normal form (that is, fully
evaluate all sub-components), and then return ().
Generic NFData deriving
Starting with GHC 7.2, you can automatically derive instances
for types possessing a Generic instance.
Note: Generic1 can be auto-derived starting with GHC 7.4
{-# LANGUAGE DeriveGeneric #-}
import GHC.Generics (Generic, Generic1)
import Control.DeepSeq
data Foo a = Foo a String
deriving (Eq, Generic, Generic1)
instance NFData a => NFData (Foo a)
instance NFData1 Foo
data Colour = Red | Green | Blue
deriving Generic
instance NFData ColourStarting with GHC 7.10, the example above can be written more
concisely by enabling the new DeriveAnyClass extension:
{-# LANGUAGE DeriveGeneric, DeriveAnyClass #-}
import GHC.Generics (Generic)
import Control.DeepSeq
data Foo a = Foo a String
deriving (Eq, Generic, Generic1, NFData, NFData1)
data Colour = Red | Green | Blue
deriving (Generic, NFData)
Compatibility with previous deepseq versions
Prior to version 1.4.0.0, the default implementation of the rnf
method was defined as
rnfa =seqa ()
However, starting with deepseq-1.4.0.0, the default
implementation is based on DefaultSignatures allowing for
more accurate auto-derived NFData instances. If you need the
previously used exact default rnf method implementation
semantics, use
instance NFData Colour where rnf x = seq x ()
or alternatively
instance NFData Colour where rnf = rwhnf
or
{-# LANGUAGE BangPatterns #-}
instance NFData Colour where rnf !_ = ()Instances
Helper functions
deepseq :: NFData a => a -> b -> b infixr 0 Source #
deepseq: fully evaluates the first argument, before returning the
second.
The name deepseq is used to illustrate the relationship to seq:
where seq is shallow in the sense that it only evaluates the top
level of its argument, deepseq traverses the entire data structure
evaluating it completely.
deepseq can be useful for forcing pending exceptions,
eradicating space leaks, or forcing lazy I/O to happen. It is
also useful in conjunction with parallel Strategies (see the
parallel package).
There is no guarantee about the ordering of evaluation. The
implementation may evaluate the components of the structure in
any order or in parallel. To impose an actual order on
evaluation, use pseq from Control.Parallel in the
parallel package.
Since: 1.1.0.0
force :: NFData a => a -> a Source #
a variant of deepseq that is useful in some circumstances:
force x = x `deepseq` x
force x fully evaluates x, and then returns it. Note that
force x only performs evaluation when the value of force x
itself is demanded, so essentially it turns shallow evaluation into
deep evaluation.
force can be conveniently used in combination with ViewPatterns:
{-# LANGUAGE BangPatterns, ViewPatterns #-}
import Control.DeepSeq
someFun :: ComplexData -> SomeResult
someFun (force -> !arg) = {- 'arg' will be fully evaluated -}Another useful application is to combine force with
evaluate in order to force deep evaluation
relative to other IO operations:
import Control.Exception (evaluate)
import Control.DeepSeq
main = do
result <- evaluate $ force $ pureComputation
{- 'result' will be fully evaluated at this point -}
return ()Finally, here's an exception safe variant of the readFile' example:
readFile' :: FilePath -> IO String
readFile' fn = bracket (openFile fn ReadMode) hClose $ \h ->
evaluate . force =<< hGetContents hSince: 1.2.0.0
($!!) :: NFData a => (a -> b) -> a -> b infixr 0 Source #
the deep analogue of $!. In the expression f $!! x, x is
fully evaluated before the function f is applied to it.
Since: 1.2.0.0
(<$!!>) :: (Monad m, NFData b) => (a -> b) -> m a -> m b infixl 4 Source #
Deeply strict version of <$>.
Since: 1.4.3.0
Liftings of the NFData class
For unary constructors
class NFData1 f where Source #
A class of functors that can be fully evaluated.
Since: 1.4.3.0
Minimal complete definition
Nothing
Methods
Instances
rnf1 :: (NFData1 f, NFData a) => f a -> () Source #
Lift the standard rnf function through the type constructor.
Since: 1.4.3.0
For binary constructors
class NFData2 p where Source #
A class of bifunctors that can be fully evaluated.
Since: 1.4.3.0
Methods
Instances
| NFData2 Either Source # | Since: 1.4.3.0 |
Defined in Control.DeepSeq | |
| NFData2 (,) Source # | Since: 1.4.3.0 |
Defined in Control.DeepSeq | |
| NFData2 Array Source # | Since: 1.4.3.0 |
Defined in Control.DeepSeq | |
| NFData2 Arg Source # | Since: 1.4.3.0 |
Defined in Control.DeepSeq | |
| NFData2 STRef Source # | Since: 1.4.3.0 |
Defined in Control.DeepSeq | |
| NFData a1 => NFData2 ((,,) a1) Source # | Since: 1.4.3.0 |
Defined in Control.DeepSeq | |
| NFData2 (Const :: Type -> Type -> Type) Source # | Since: 1.4.3.0 |
Defined in Control.DeepSeq | |
| NFData2 ((:~:) :: Type -> Type -> Type) Source # | Since: 1.4.3.0 |
Defined in Control.DeepSeq | |
| (NFData a1, NFData a2) => NFData2 ((,,,) a1 a2) Source # | Since: 1.4.3.0 |
Defined in Control.DeepSeq | |
| NFData2 ((:~~:) :: Type -> Type -> Type) Source # | Since: 1.4.3.0 |
Defined in Control.DeepSeq | |
| (NFData a1, NFData a2, NFData a3) => NFData2 ((,,,,) a1 a2 a3) Source # | Since: 1.4.3.0 |
Defined in Control.DeepSeq | |
| (NFData a1, NFData a2, NFData a3, NFData a4) => NFData2 ((,,,,,) a1 a2 a3 a4) Source # | Since: 1.4.3.0 |
Defined in Control.DeepSeq | |
| (NFData a1, NFData a2, NFData a3, NFData a4, NFData a5) => NFData2 ((,,,,,,) a1 a2 a3 a4 a5) Source # | Since: 1.4.3.0 |
Defined in Control.DeepSeq | |
| (NFData a1, NFData a2, NFData a3, NFData a4, NFData a5, NFData a6) => NFData2 ((,,,,,,,) a1 a2 a3 a4 a5 a6) Source # | Since: 1.4.3.0 |
Defined in Control.DeepSeq | |
| (NFData a1, NFData a2, NFData a3, NFData a4, NFData a5, NFData a6, NFData a7) => NFData2 ((,,,,,,,,) a1 a2 a3 a4 a5 a6 a7) Source # | Since: 1.4.3.0 |
Defined in Control.DeepSeq | |