Skip to content

//okhttp/okhttp3/Response/peekBody

peekBody

[common, nonJvm]\ [common]\ expect fun peekBody(byteCount: Long): ResponseBody

[nonJvm]\ actual fun peekBody(byteCount: Long): ResponseBody

Peeks up to byteCount bytes from the response body and returns them as a new response body. If fewer than byteCount bytes are in the response body, the full response body is returned. If more than byteCount bytes are in the response body, the returned value will be truncated to byteCount bytes.

It is an error to call this method after the body has been consumed.

Warning: this method loads the requested bytes into memory. Most applications should set a modest limit on byteCount, such as 1 MiB.

[jvm]\ actual fun peekBody(byteCount: Long): ResponseBody