Resolve ambiguity issue of stream
#748
Conversation
… length. Change type for length from `Int64?` to enum-backed type.
| if case .known(let count) = self.contentLength.length { | ||
| return Int(count) | ||
| } | ||
| return nil |
There was a problem hiding this comment.
nit: prefer switching exhaustively over enums
| } | ||
| } | ||
|
|
||
| /// Body size. If nil,`Transfer-Encoding` will automatically be set to `chunked`. Otherwise a `Content-Length` | ||
| /// header is set with the given `contentLength`. | ||
| public var contentLength: Int64? | ||
| public var contentLength: Length |
There was a problem hiding this comment.
We can't make this change, it's an API break. We could work around it by adding a new length property using the new type and have computed getters/setters on contentLength.
However I don't think we should make this change: Length doesn't allow the user to recover the (known) length value. I think if we want to use this type it should only be at the surface level in the stream func. It also makes me wonder whether we should do this at all and just use @_disfavoredOverload. WDYT @FranzBusch?
There was a problem hiding this comment.
This is a new not an API break because we haven't released the API yet afaik but I agree exposing this var is weird. @fabianfett what do you think?
There was a problem hiding this comment.
We haven't released this API yet. Therefore this will not be a breaking change. Generally I'm in favor of using @_disfavoredOverload on the Int version of this API as well as the initializers that use trailing closure syntax.
|
Closing this PR as it now has too many unneeded changes and creating a new one with the |
Motivation:
streamfunction inHTTPClientRequest.Body(newly added in Add support for request body to be larger than 2GB on 32-bit devices #746) is ambiguous with the existingstreamfunction as the first argument has a default value and the second argument is a closure. This is API-breaking.Modifications:
nil.Int64?to an enum-backed structLength. This struct uses the existing internal enumRequestBodyLengthwhich has cases.unknownand.known(_ count: Int64).Result:
streamfunction (as well as the initializer forBody) is now more readable as it has to be spelled out explicitly as.unknownrather than an unclearnil.