@@ -6,11 +6,11 @@
66### Significant changes
77
88- Streaming refactoring. [#991](https://github.com/haskell-servant/servant/pull/991)
9−
9+
1010 The streaming functionality (`Servant.API.Stream`) is refactored to use
1111 `servant` own `SourceIO` type (see `Servant.Types.SourceT` documentation),
1212 which replaces both `StreamGenerator` and `ResultStream` types.
13−
13+
1414 New conversion type-classes are `ToSourceIO` and `FromSourceIO`
1515 (replacing `ToStreamGenerator` and `BuildFromStream`).
1616 There are instances for *conduit*, *pipes* and *machines* in new packages:
@@ -36,7 +36,7 @@
3636 - `Servant.Client.Streaming` is *used* by CPSised
3737 `withClientM :: ClientM a -> ClientEnv -> (Either ServantError a -> IO b) -> IO b`
3838
39− If you need to access `Stream` endpoints use `Servant.Client.Streaming` with
39+ To access `Stream` endpoints use `Servant.Client.Streaming` with
4040 `withClientM`; otherwise you can continue using `Servant.Client` with `runClientM`.
4141 You can use both too, `ClientEnv` and `BaseUrl` types are same for both.
4242
@@ -44,6 +44,14 @@
4444 Requesting ordinary `Verb` endpoints (e.g. `Get`) will block until
4545 the whole response is received.
4646
47+ There is `Servant.Client.Streaming.runClientM` function, but it has
48+ restricted type. `NFData a` constraint prevents using it with
49+ `SourceT`, `Conduit` etc. response types.
50+
51+ ```haskell
52+ runClientM :: NFData a => ClientM a -> ClientEnv -> IO (Either ServantError a)
53+ ```
54+
4755 This change shouldn't affect you, if you don't use streaming endpoints.
4856
4957- Drop support for GHC older than 8.0
@@ -51,7 +59,7 @@
5159 [#1009](https://github.com/haskell-servant/servant/pull/1009)
5260
5361- `ComprehensiveAPI` is a part of public API in `Servant.Test.ComprehensiveAPI`` module.
54− This API type is used to verify that libraries implement all core combinators.
62+ This API type is used to verify that libraries implement all core combinators.
5563 Now we won't change this type between major versions.
5664 (This has been true for some time already).
5765 [#1070](https://github.com/haskell-servant/servant/pull/1070)
@@ -62,6 +70,9 @@
6270
6371### Other changes
6472
73+- *servant-client-core* Add `NFData (GenResponse a)` and `NFData ServantError` instances.
74+ [#1076](https://github.com/haskell-servant/servant/pull/1076)
75+
6576- *servant* Add `lookupResponseHeader :: ... => Headers headers r -> ResponseHeader h a`
6677 [#1064](https://github.com/haskell-servant/servant/pull/1064)
6778