simbot-api/love.forte.simbot.resources

Package-level declarations

Types

BinaryFormatDeserializableResourceDecoder

abstract class BinaryFormatDeserializableResourceDecoder : SerialFormatDeserializableResourceDecoder

基于 kotlinx.serialization 中的 StringFormat 所实现的抽象 DeserializableResourceDecoder.

ByteArrayResource

@SerialName(value = "simbot.resource.bytes")

@Serializable

class ByteArrayResource(val name: String, byteArray: ByteArray) : StandardResource

使用 ByteArray 字节数组作为输入流来源的 StandardResource.

DeserializableResource

interface DeserializableResource : Resource

代表为一个可以进行反序列化的 Resource 类型，提供了一个 decode 函数来将当前资源中的信息解析为目标类型。

DeserializableResourceDecoder

interface DeserializableResourceDecoder

对 DeserializableResource 进行反序列化的解码器。

FileResource

@SerialName(value = "simbot.resource.file")

@Serializable

class FileResource(val file: File, val name: String = file.toString(), doClose: () -> Unit = {}) : StandardResource

使用File作为输入流来源的 StandardResource.

PathResource

@SerialName(value = "simbot.resource.path")

@Serializable

class PathResource(val path: Path, val name: String = path.toString(), doClose: () -> Unit = {}) : StandardResource

使用Path作为输入流来源的 StandardResource.

Resource

interface Resource : Closeable

一个资源. 代表一个允许获取数据流的资源，这通常代表了对本地资源（比如文件）、远程资源（比如某个链接）等资源，一般可以使用在接收者需要上传某些资源或者得到了一些能够下载的资源的情况下。比如上传图片、下载图片。

SerialFormatDeserializableResourceDecoder

abstract class SerialFormatDeserializableResourceDecoder : DeserializableResourceDecoder

基于 kotlinx.serialization 的 SerialFormat 所实现的抽象 DeserializableResourceDecoder.

SimpleBinaryFormatDeserializableResourceDecoder

class SimpleBinaryFormatDeserializableResourceDecoder<F : BinaryFormat>(val format: F) : BinaryFormatDeserializableResourceDecoder

BinaryFormatDeserializableResourceDecoder 的基础实现，提供一个 format 作为解析器。

SimpleStringFormatDeserializableResourceDecoder

class SimpleStringFormatDeserializableResourceDecoder<F : StringFormat>(val format: F) : StringFormatDeserializableResourceDecoder

StringFormatDeserializableResourceDecoder 的基础实现，提供一个 format 作为解析器。

StandardResource

@SerialName(value = "simbot.resource.standard")

@Serializable

sealed class StandardResource : Resource, Closeable

Resource 的标准实现类型.

StringFormatDeserializableResourceDecoder

abstract class StringFormatDeserializableResourceDecoder : SerialFormatDeserializableResourceDecoder

基于 kotlinx.serialization 中的 StringFormat 所实现的抽象 DeserializableResourceDecoder.

URLResource

@SerialName(value = "simbot.resource.url")

@Serializable

class URLResource(val url: URL, val name: String = url.toString()) : StandardResource

使用URL作为输入流来源的 StandardResource.

Functions

useToResource

fun InputStream.useToResource(name: String? = null): StandardResource

将作为receiver的输入流转化为一个 StandardResource, 同时关闭输入流。