From a4f0bbfe80d6ff3748489c4eeeb7676e3d5cb3f4 Mon Sep 17 00:00:00 2001 From: Karlatemp Date: Mon, 5 Jul 2021 18:16:53 +0800 Subject: [PATCH] Fix document of `RandomAccessFile.toExternalResource()` --- docs/ConciseAPI.md | 5 +++-- .../src/commonMain/kotlin/utils/ExternalResource.kt | 2 ++ 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/docs/ConciseAPI.md b/docs/ConciseAPI.md index f9ecdb8aa..2dd42f044 100644 --- a/docs/ConciseAPI.md +++ b/docs/ConciseAPI.md @@ -46,8 +46,9 @@ ExternalResource.create(new File("foo.txt")) > 注: > - `ExternalResource` 和 `java.io.InputStream` 等资源一样, 需要手动关闭 `close()` -> - 使用 `java.io.InputStream`, `java.io.RandomAccessFile` 构造 `ExternalResource` -> 时, 需要关闭 `java.io.InputStream` 或 `java.io.RandomAccessFile` +> - 使用 `java.io.InputStream` 构造 `ExternalResource` 时, 需要关闭 `java.io.InputStream` +> - 使用 `java.io.RandomAccessFile` 构造 `ExternalResource` 时, 请不要关闭 `RandomAccessFile`, +> 否则会间接关闭 `ExternalResource` ```kotlin diff --git a/mirai-core-api/src/commonMain/kotlin/utils/ExternalResource.kt b/mirai-core-api/src/commonMain/kotlin/utils/ExternalResource.kt index 9f55af2a1..3f3636bea 100644 --- a/mirai-core-api/src/commonMain/kotlin/utils/ExternalResource.kt +++ b/mirai-core-api/src/commonMain/kotlin/utils/ExternalResource.kt @@ -148,6 +148,8 @@ public interface ExternalResource : Closeable { /** * 创建 [ExternalResource]. * + * **注意**：使用此方法时请不要关闭 [RandomAccessFile], 否则会间接关闭 [ExternalResource] + * * @see closeOriginalFileOnClose 若为 `true`, 在 [ExternalResource.close] 时将会同步关闭 [RandomAccessFile]. 否则不会. * * @param formatName 查看 [ExternalResource.formatName]