android/okhttp
1
0
Fork 0
mirror of https://github.com/square/okhttp.git synced 2026-01-12 10:23:16 +03:00
Code Releases Activity

Strengthen the docs on Response.body (#8768)

Browse Source 
Be very explicit about what's allowed and what's not.
This commit is contained in:
Jesse Wilson
2025-05-12 21:45:52 -04:00
committed by GitHub
parent e7b86fed23
commit e72cfb12f7
1 changed files with 8 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
okhttp/src/commonJvmAndroid/kotlin/okhttp3/Response.kt
View File

@@ -79,12 +79,15 @@ class Response internal constructor(
/** Returns the HTTP headers. */
@get:JvmName("headers") val headers: Headers,
/**
* Returns a non-null value if this response was passed to [Callback.onResponse] or returned
* from [Call.execute]. Response bodies must be [closed][ResponseBody] and may
* be consumed only once.
* Returns a non-null stream with the server's response. The returned value must be
* [closed][ResponseBody] and may be consumed only once.
*
* This always returns an unreadable [ResponseBody], which may implement [ResponseBody.contentType] and [ResponseBody.contentLength], on responses returned from [cacheResponse], [networkResponse],
* and [priorResponse].
* If this is a [cacheResponse], [networkResponse], or [priorResponse], the server's response body
* is not available and it is always an error to attempt read its streamed content. Reading from
* [ResponseBody.source] always throws on such instances.
*
* It is safe and supported to call [ResponseBody.contentType] and [ResponseBody.contentLength] on
* all instances of [ResponseBody].
*/
@get:JvmName("body") val body: ResponseBody,
/**