Skip to content

Document ResourceStream close behavior #52

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
veewee merged 1 commit into from
Apr 7, 2026
Merged

Document ResourceStream close behavior #52

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/transports.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,10 @@ This package contains some frequently used encoders / decoders for you:
| `StreamDecoder` | `DecoderInterface<StreamInterface>` | Returns the PSR-7 Stream as response result |
| `StreamEncoder` | `EncoderInterface<StreamInterface>` | Adds PSR-7 Stream as request body |

> **Note:** The `ResourceStreamEncoder` passes the underlying PHP resource to a PSR-7 stream.
> PSR-7's `StreamInterface::close()` will close this resource, which also closes the original `ResourceStream`.
> If you need to reuse the resource after sending a request, pass a copy of the stream (e.g. via `$stream->copyTo(MemoryStream::create())`) to the encoder instead.

## Built-in transport presets:

We've composed some of the encodings above into pre-configured transports:
Expand Down
Loading