swift-server / swift-server/async-http-client
unclear docs: How to signal to StreamWriter that body is done?
Open
Nobody has claimed this yet.
kind/enhancement
- Dominant language
- Swift
- Stars
- 1.1k
- Forks
- 156
- PR merge metrics
- No merged PRs in 30d
Description
StreamWriter's complete docs are
/// Chunk provider.
public struct StreamWriter {
/// Write data to server.
///
/// - parameters:
/// - data: `IOData` to write.
public func write(_ data: IOData) -> EventLoopFuture<Void>
}
I understand how I can provide chunks: by calling write but how do I tell the StreamWriter that I'm done sending request body bytes?
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the StreamWriter API documentation shown in the issue and the related comment thread. Determine how completion of the request body is signaled, then document that usage and verify that the explanation matches the StreamWriter behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- swift
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100