Skip to content

class HttpContent

cangjie
public abstract class HttpContent <: Resource

功能:表示 HTTP 内容体的抽象基类。

父类型:

  • Resource

成员概览

成员功能
prop headers获取内容头集合。
func readAsStream()以流形式读取内容体。
func readAsString()以字符串形式读取内容体。
func readAsByteArray()以字节数组形式读取内容体。
func createContentReadStream()创建用于读取内容体的输入流。
func loadIntoBuffer()将当前内容加载到内存缓冲区。
func readFromJson()将 JSON 内容反序列化为指定类型。
func readFromJson(JsonSerializerOptions)使用指定选项将 JSON 内容反序列化为目标类型。
func close()释放当前内容对象。
func isClosed()检查当前内容是否已释放。
func close(Bool)执行内容关闭时的扩展逻辑。

prop headers

cangjie
public prop headers: HttpContentHeaders

功能:获取内容头集合。

类型:HttpContentHeaders

func readAsStream()

cangjie
public func readAsStream(): InputStream

功能:以流形式读取内容体。

返回值:

  • InputStream - 可读取当前内容体的输入流。

异常:

func readAsString()

cangjie
public func readAsString(): String

功能:以字符串形式读取内容体。

返回值:

  • String - 当前内容体的字符串表示。

异常:

func readAsByteArray()

cangjie
public func readAsByteArray(): Array<Byte>

功能:以字节数组形式读取内容体。

返回值:

  • Array<Byte> - 当前内容体的字节数组表示。

异常:

func createContentReadStream()

cangjie
public open func createContentReadStream(): InputStream

功能:创建用于读取内容体的输入流。

返回值:

  • InputStream - 可读取当前内容体的输入流。

异常:

func loadIntoBuffer()

cangjie
public func loadIntoBuffer(): Unit

功能:将当前内容加载到内存缓冲区。

返回值:

  • Unit - 无返回值。

异常:

func readFromJson()

cangjie
public func readFromJson<T>(): T where T <: ISerialization<T>

功能:将 JSON 内容反序列化为指定类型。

返回值:

  • T - 反序列化后的对象。

异常:

func readFromJson(JsonSerializerOptions)

cangjie
public func readFromJson<T>(options: JsonSerializerOptions): T where T <: ISerialization<T>

功能:使用指定选项将 JSON 内容反序列化为目标类型。

参数:

返回值:

  • T - 反序列化后的对象。

异常:

func close()

cangjie
public func close(): Unit

功能:释放当前内容对象。

返回值:

  • Unit - 无返回值。

func isClosed()

cangjie
public open func isClosed(): Bool

功能:检查当前内容是否已释放。

返回值:

  • Bool - 已释放时返回 true

func close(Bool)

cangjie
protected open func close(_: Bool): Unit

功能:执行内容关闭时的扩展逻辑。

参数:

  • _: Bool - 是否执行关闭动作。

返回值:

  • Unit