simbot-api/love.forte.simbot.resource

Package-level declarations

Types

AbstractJvmResourceResolver

@ScheduledDeprecatedResourceApi

abstract class AbstractJvmResourceResolver<C> : JvmResourceResolver<C>

JvmResourceResolver 的更安全的抽象类型，将 resolveUnknown 固定为 final。

AbstractJvmResourceValueResolver

@ScheduledDeprecatedResourceApi

abstract class AbstractJvmResourceValueResolver<C> : JvmResourceValueResolver<C>

JvmResourceValueResolver 的更安全的抽象类型，会将部分直接解析 Resource 的函数固定为 final。

ByteArrayResource

interface ByteArrayResource : Resource, SourceResource

直接使用 ByteArray 作为 data 结果的 Resource 实现。

ExperimentalIOResourceAPI

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.ANNOTATION_CLASS, AnnotationTarget.PROPERTY, AnnotationTarget.FIELD, AnnotationTarget.LOCAL_VARIABLE, AnnotationTarget.VALUE_PARAMETER, AnnotationTarget.CONSTRUCTOR, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY_GETTER, AnnotationTarget.PROPERTY_SETTER, AnnotationTarget.TYPEALIAS])

annotation class ExperimentalIOResourceAPI

一些尚处于实验阶段的、基于IO(主要指文件系统相关)的 Resource 相关API。

FileResource

interface FileResource : JvmSourceResource, InputStreamResource, ReaderResource

FileResource 接口表示一个可从文件获取流的资源。该接口提供一个 File 对象和两种方法来获取输入流和读取文件的字节数组。

InputStreamResource

interface ~~InputStreamResource~~ : SourceResource

能够获取到 InputStream 资源的 Resource 扩展实现。

JvmResourceResolver

@ScheduledDeprecatedResourceApi

interface JvmResourceResolver<C> : ResourceResolver<C>

JVM 平台下 ResourceResolver 的进一步扩展类型。

JvmResourceValueResolver

@ScheduledDeprecatedResourceApi

interface JvmResourceValueResolver<C> : JvmResourceResolver<C>

基于 Resource 中的值进行处理。其中，如果 URI.scheme == "file" 则会被处理为 Path.

JvmSourceResource

sealed interface JvmSourceResource : SourceResource

提供JVM平台独特实现的类型，与 SourceResource 内容相同。

JvmStringReadableResource

interface JvmStringReadableResource : StringReadableResource

JVM 平台下可以读取到字符串内容的 StringReadableResource 类型。与 StringReadableResource 相比，对相关方法增加了 Charset 参数。默认情况下使用 Charsets.UTF_8 格式编码。

PathResource

interface PathResource : JvmSourceResource, InputStreamResource, ReaderResource

PathResource 接口表示一个可从 Path 获取流的资源。该接口提供一个 Path 对象和两种方法来获取输入流和读取文件的字节数组。

ReaderResource

interface ~~ReaderResource~~ : JvmStringReadableResource

能够获取到 Reader 资源的 Resource 扩展实现。

Resource

sealed interface Resource

一个资源。

ResourceBase64Serializer

@ExperimentalEncodingApi

object ResourceBase64Serializer : KSerializer<Resource>

基于 Base64 的 Resource 序列化器。

ResourceImplementation

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.ANNOTATION_CLASS])

annotation class ResourceImplementation

Resource 的外部实现是不稳定的，Resource 的实现应该是内部的，目前 Resource 不保证第三方实现未来的稳定与兼容。

ResourceResolver

@ScheduledDeprecatedResourceApi

interface ResourceResolver<C>

使用 ResourceResolver 分析处理一个 Resource. 类似于 visitor 的用法，与常见地访问器区别于通常情况下只会有一个 resolve* 会最终执行。

ScheduledDeprecatedResourceApi

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION])

annotation class ScheduledDeprecatedResourceApi

计划被废弃的与 Resource 相关的API

SourceResource

interface SourceResource : Resource

一个可以得到 kotlinx.io.Source 的 Resource。

StringReadableResource

interface StringReadableResource : SourceResource

一个可以读取到 String 内容物的拓展类型。是其他 Resource 类型的附加能力，但不属于一个标准的 Resource 类型。

StringResource

interface StringResource : StringReadableResource

直接使用 String 作为内容的 Resource。

URIResource

interface URIResource : JvmSourceResource, InputStreamResource, JvmStringReadableResource

URIResource 是一个输入流资源的接口。

Functions

fileResource

@JvmName(name = "valueOfPath")

fun fileResource(filePath: String): SourceResource

根据完整的文件路径 filePath 得到一个基于对应文件的 Resource。

@JvmName(name = "valueOfPath")

fun fileResource(base: String, vararg parts: String): SourceResource

根据文件路径片段集得到一个基于对应文件的 Resource。

inputStreamResource

@JvmName(name = "valueOfInputStreamProvider")

fun inputStreamResource(provider: () -> InputStream): SourceResource

提供一个用于产生 InputStream 的供应函数 provider，并得到一个 SourceResource。

sourceResource

@JvmName(name = "valueOfSourceProvider")

fun sourceResource(provider: () -> Source): SourceResource

提供一个用于产生 Source 的供应函数 provider，并得到一个 SourceResource。

Inherited functions

inputStream

fun SourceResource.inputStream(): InputStream

从 SourceResource 中通过 Source 获取一个 InputStream。

toResource

@JvmName(name = "valueOf")

fun ByteArray.toResource(): ByteArrayResource

通过提供的 ByteArray 直接构建一个 Resource。

@JvmName(name = "valueOf")

fun Path.toResource(): SourceResource

使用 Path 直接构建一个 KotlinIOPathResource

@JvmName(name = "valueOf")

@JvmOverloads

fun File.toResource(charset: Charset = DEFAULT_CHARSET): FileResource

Converts a File to a FileResource. charset 会作为需要使用编码参数的方法的默认编码。默认使用 JvmStringReadableResource.DEFAULT_CHARSET。

@JvmName(name = "valueOf")

@JvmOverloads

fun URI.toResource(charset: Charset = DEFAULT_CHARSET): URIResource

Converts the current URI to a URIResource.

@JvmName(name = "valueOf")

@JvmOverloads

fun URL.toResource(charset: Charset = DEFAULT_CHARSET): URIResource

Converts the current URL to a URIResource.

@JvmName(name = "valueOf")

@JvmOverloads

fun Path.toResource(charset: Charset = DEFAULT_CHARSET, vararg options: OpenOption): PathResource

Converts the given Path to a PathResource with the specified options.

toStringResource

@JvmName(name = "valueOf")

fun String.toStringResource(): StringResource

通过提供的 String 直接构建一个 StringResource。