github-repos/mirai
1
0
Fork 0
mirror of https://github.com/mamoe/mirai.git synced 2025-01-27 08:50:15 +08:00
Code Issues Packages Projects Releases Wiki Activity

Fix document of RandomAccessFile.toExternalResource()

Browse Source
This commit is contained in:
Karlatemp 2021-07-05 18:16:53 +08:00
parent 69f2d24c22
commit a4f0bbfe80
No known key found for this signature in database
GPG Key ID: 21FBDDF664FF06F8
2 changed files with 5 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/ConciseAPI.md
View File

@ -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

2
mirai-core-api/src/commonMain/kotlin/utils/ExternalResource.kt
View File

@ -148,6 +148,8 @@ public interface ExternalResource : Closeable {
/**
* 创建 [ExternalResource].
*
* **注意**：使用此方法时请不要关闭 [RandomAccessFile], 否则会间接关闭 [ExternalResource]
*
* @see closeOriginalFileOnClose 若为 `true`, 在 [ExternalResource.close] 时将会同步关闭 [RandomAccessFile]. 否则不会.
*
* @param formatName 查看 [ExternalResource.formatName]