ResultBody (OkHttps 4.1.0 API)

java.lang.Object
- cn.zhxu.okhttps.internal.AbstractBody
- - cn.zhxu.okhttps.internal.ResultBody

所有已实现的接口:: HttpResult.Body, Toable

public class ResultBody
extends AbstractBody
implements HttpResult.Body

字段概要
- 从类继承的字段 cn.zhxu.okhttps.internal.AbstractBody
  charset, taskExecutor

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`HttpResult.Body`	`cache()` 缓存自己，缓存后可重复使用 toXXX 类方法
`HttpResult.Body`	`close()` 关闭报文体未对报文体做任何消费时使用，比如只读取长度
`protected InputStream`	`convertingStream()`
`long`	`getLength()` 依赖于 Content-Length 响应头
`okhttp3.MediaType`	`getType()` will be removed in next version
`HttpResult.Body`	`nextOnIO()` 在IO线程执行
`HttpResult.Body`	`setOnProcess(Consumer<Process> onProcess)` 设置报文体接收进度回调
`HttpResult.Body`	`setRangeIgnored()` 设置进度回调忽略响应的Range头信息，即进度回调会从0开始
`HttpResult.Body`	`stepBytes(long stepBytes)` 设置进度回调的步进字节，默认 8K（8192）表示每接收 stepBytes 个字节，执行一次进度回调
`HttpResult.Body`	`stepRate(double stepRate)` 设置进度回调的步进比例表示每接收 stepRate 比例，执行一次进度回调
`byte[]`	`toBytes()`
`InputStream`	`toByteStream()`
`okio.ByteString`	`toByteString()` will be removed in next version
`Reader`	`toCharStream()`
`Download`	`toFile(File file)` 下载到指定文件同一个 Body 对象的 toXXX 类方法只可使用一个并且只能调用一次
`Download`	`toFile(String filePath)` 下载到指定路径同一个 Body 对象的 toXXX 类方法只可使用一个并且只能调用一次
`Download`	`toFolder(File dir)` 下载到指定文件夹同一个 Body 对象的 toXXX 类方法只可使用一个并且只能调用一次
`Download`	`toFolder(String dirPath)` 下载到指定文件夹同一个 Body 对象的 toXXX 类方法只可使用一个并且只能调用一次
`String`	`toString()`

从类继承的方法 cn.zhxu.okhttps.internal.AbstractBody
doToBean, toArray, toBean, toBean, toBean, toList, toMapper

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

从接口继承的方法 cn.zhxu.okhttps.Toable
toArray, toBean, toBean, toBean, toList, toMapper

- 方法详细资料
  - getType
```
public okhttp3.MediaType getType()
```
    从接口复制的说明: HttpResult.Body
    
    will be removed in next version
    
    指定者:
    
    getType 在接口中 HttpResult.Body
    
    返回:
    
    媒体类型
  - getLength
```
public long getLength()
```
    从接口复制的说明: HttpResult.Body
    
    依赖于 Content-Length 响应头
    
    指定者:
    
    getLength 在接口中 HttpResult.Body
    
    返回:
    
    报文体字节长度
  - nextOnIO
```
public HttpResult.Body nextOnIO()
```
    从接口复制的说明: HttpResult.Body
    
    在IO线程执行
    
    指定者:
    
    nextOnIO 在接口中 HttpResult.Body
    
    返回:
    
    Body
  - setOnProcess
```
public HttpResult.Body setOnProcess(Consumer<Process> onProcess)
```
    从接口复制的说明: HttpResult.Body
    
    设置报文体接收进度回调
    
    指定者:
    
    setOnProcess 在接口中 HttpResult.Body
    
    参数:
    
    onProcess - 进度回调函数
    
    返回:
    
    Body
  - stepBytes
```
public HttpResult.Body stepBytes(long stepBytes)
```
    从接口复制的说明: HttpResult.Body
    
    设置进度回调的步进字节，默认 8K（8192）表示每接收 stepBytes 个字节，执行一次进度回调
    
    指定者:
    
    stepBytes 在接口中 HttpResult.Body
    
    参数:
    
    stepBytes - 步进字节
    
    返回:
    
    Body
  - stepRate
```
public HttpResult.Body stepRate(double stepRate)
```
    从接口复制的说明: HttpResult.Body
    
    设置进度回调的步进比例表示每接收 stepRate 比例，执行一次进度回调
    
    指定者:
    
    stepRate 在接口中 HttpResult.Body
    
    参数:
    
    stepRate - 步进比例
    
    返回:
    
    Body
  - setRangeIgnored
```
public HttpResult.Body setRangeIgnored()
```
    从接口复制的说明: HttpResult.Body
    
    设置进度回调忽略响应的Range头信息，即进度回调会从0开始
    
    指定者:
    
    setRangeIgnored 在接口中 HttpResult.Body
    
    返回:
    
    Body
  - convertingStream
```
protected InputStream convertingStream()
```
    覆盖:
    
    convertingStream 在类中 AbstractBody
    
    返回:
    
    待转换的输入流
  - toByteStream
```
public InputStream toByteStream()
```
    指定者:
    
    toByteStream 在接口中 Toable
    
    返回:
    
    消息体转字节流
  - toBytes
```
public byte[] toBytes()
```
    指定者:
    
    toBytes 在接口中 Toable
    
    返回:
    
    消息体转字节数组
  - toCharStream
```
public Reader toCharStream()
```
    指定者:
    
    toCharStream 在接口中 Toable
    
    返回:
    
    消息体转字符流
  - toString
```
public String toString()
```
    指定者:
    
    toString 在接口中 Toable
    
    覆盖:
    
    toString 在类中 Object
    
    返回:
    
    消息体转字符串
  - toByteString
```
public okio.ByteString toByteString()
```
    从接口复制的说明: Toable
    
    will be removed in next version
    
    指定者:
    
    toByteString 在接口中 Toable
    
    返回:
    
    ByteString
  - toFile
```
public Download toFile(String filePath)
```
    从接口复制的说明: HttpResult.Body
    
    下载到指定路径同一个 Body 对象的 toXXX 类方法只可使用一个并且只能调用一次
    
    指定者:
    
    toFile 在接口中 HttpResult.Body
    
    参数:
    
    filePath - 目标路径
    
    返回:
    
    下载过程 #Download
  - toFile
```
public Download toFile(File file)
```
    从接口复制的说明: HttpResult.Body
    
    下载到指定文件同一个 Body 对象的 toXXX 类方法只可使用一个并且只能调用一次
    
    指定者:
    
    toFile 在接口中 HttpResult.Body
    
    参数:
    
    file - 目标文件
    
    返回:
    
    下载过程 #Download
  - toFolder
```
public Download toFolder(String dirPath)
```
    从接口复制的说明: HttpResult.Body
    
    下载到指定文件夹同一个 Body 对象的 toXXX 类方法只可使用一个并且只能调用一次
    
    指定者:
    
    toFolder 在接口中 HttpResult.Body
    
    参数:
    
    dirPath - 目标目录
    
    返回:
    
    下载过程 #Download
  - toFolder
```
public Download toFolder(File dir)
```
    从接口复制的说明: HttpResult.Body
    
    下载到指定文件夹同一个 Body 对象的 toXXX 类方法只可使用一个并且只能调用一次
    
    指定者:
    
    toFolder 在接口中 HttpResult.Body
    
    参数:
    
    dir - 目标目录
    
    返回:
    
    下载过程 #Download
  - cache
```
public HttpResult.Body cache()
```
    从接口复制的说明: HttpResult.Body
    
    缓存自己，缓存后可重复使用 toXXX 类方法
    
    指定者:
    
    cache 在接口中 HttpResult.Body
    
    返回:
    
    Body
  - close
```
public HttpResult.Body close()
```
    从接口复制的说明: HttpResult.Body
    
    关闭报文体未对报文体做任何消费时使用，比如只读取长度
    
    指定者:
    
    close 在接口中 HttpResult.Body
    
    返回:
    
    Body

类 ResultBody

字段概要

从类继承的字段 cn.zhxu.okhttps.internal.AbstractBody

方法概要

从类继承的方法 cn.zhxu.okhttps.internal.AbstractBody

从类继承的方法 java.lang.Object

从接口继承的方法 cn.zhxu.okhttps.Toable

方法详细资料

getType

getLength

nextOnIO

setOnProcess

stepBytes

stepRate

setRangeIgnored

convertingStream

toByteStream

toBytes

toCharStream

toString

toByteString

toFile

toFile

toFolder

toFolder

cache

close