CHANGELOG.rst 3.8 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394
  1. =========
  2. Changelog
  3. =========
  4. 3.0.0 (2014-10-12)
  5. ------------------
  6. * Now supports creating streams from functions and iterators.
  7. * Supports creating buffered streams and asynchronous streams.
  8. * Removed ``functions.php``. Use the corresponding functions provided by
  9. ``GuzzleHttp\Streams\Utils`` instead.
  10. * Moved ``GuzzleHttp\Stream\MetadataStreamInterface::getMetadata`` to
  11. ``GuzzleHttp\Stream\StreamInterface``. MetadataStreamInterface is no longer
  12. used and is marked as deprecated.
  13. * Added ``attach()`` to ``GuzzleHttp\Stream\StreamInterface`` for PSR-7
  14. compatibility.
  15. * Removed ``flush()`` from StreamInterface.
  16. * Removed the ``$maxLength`` parameter from
  17. ``GuzzleHttp\Stream\StreamInterface::getContents()``. This function now
  18. returns the entire remainder of the stream. If you want to limit the maximum
  19. amount of data read from the stream, use the
  20. ``GuzzleHttp\Stream\Utils::copyToString()`` function.
  21. * Streams that return an empty string, ``''``, are no longer considered a
  22. failure. You MUST return ``false`` to mark the read as a failure, and ensure
  23. that any decorators you create properly return ``true`` in response to the
  24. ``eof()`` method when the stream is consumed.
  25. * ``GuzzleHttp\Stream\Stream::__construct``,
  26. ``GuzzleHttp\Stream\Stream::factory``, and
  27. ``GuzzleHttp\Stream\Utils::create`` no longer accept a size in the second
  28. argument. They now accept an associative array of options, including the
  29. "size" key and "metadata" key which can be used to provide custom metadata.
  30. * Added ``GuzzleHttp\Stream\BufferStream`` to add support for buffering data,
  31. and when read, shifting data off of the buffer.
  32. * Added ``GuzzleHttp\Stream\NullBuffer`` which can be used as a buffer that
  33. does not actually store any data.
  34. * Added ``GuzzleHttp\Stream\AsyncStream`` to provide support for non-blocking
  35. streams that can be filled by a remote source (e.g., an event-loop). If a
  36. ``drain`` option is provided, the stream can also act as if it is a blocking
  37. stream.
  38. 2.1.0 (2014-08-17)
  39. ------------------
  40. * Added an InflateStream to inflate gzipped or deflated content.
  41. * Added ``flush`` to stream wrapper.
  42. * Added the ability to easily register the GuzzleStreamWrapper if needed.
  43. 2.0.0 (2014-08-16)
  44. ------------------
  45. * Deprecated functions.php and moved all of those methods to
  46. ``GuzzleHttp\Streams\Utils``. Use ``GuzzleHttp\Stream\Stream::factory()``
  47. instead of ``GuzzleHttp\Stream\create()`` to create new streams.
  48. * Added ``flush()`` to ``StreamInterface``. This method is used to flush any
  49. underlying stream write buffers.
  50. * Added ``FnStream`` to easily decorate stream behavior with callables.
  51. * ``Utils::hash`` now throws an exception when the stream cannot seek to 0.
  52. 1.5.1 (2014-09-10)
  53. ------------------
  54. * Stream metadata is grabbed from the underlying stream each time
  55. ``getMetadata`` is called rather than returning a value from a cache.
  56. * Properly closing all underlying streams when AppendStream is closed.
  57. * Seek functions no longer throw exceptions.
  58. * LazyOpenStream now correctly returns the underlying stream resource when
  59. detached.
  60. 1.5.0 (2014-08-07)
  61. ------------------
  62. * Added ``Stream\safe_open`` to open stream resources and throw exceptions
  63. instead of raising errors.
  64. 1.4.0 (2014-07-19)
  65. ------------------
  66. * Added a LazyOpenStream
  67. 1.3.0 (2014-07-15)
  68. ------------------
  69. * Added an AppendStream to stream over multiple stream one after the other.
  70. 1.2.0 (2014-07-15)
  71. ------------------
  72. * Updated the ``detach()`` method to return the underlying stream resource or
  73. ``null`` if it does not wrap a resource.
  74. * Multiple fixes for how streams behave when the underlying resource is
  75. detached
  76. * Do not clear statcache when a stream does not have a 'uri'
  77. * Added a fix to LimitStream
  78. * Added a condition to ensure that functions.php can be required multiple times