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

Add unstable api note

Browse Source
This commit is contained in:
Him188 2020-01-07 13:51:16 +08:00
parent 2f59504e04
commit 02d837db00
1 changed files with 2 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
mirai-core/src/commonMain/kotlin/net.mamoe.mirai/utils/WeakRef.kt
View File

@ -62,6 +62,8 @@ fun <T> WeakRef<T>.unsafe(): UnsafeWeakRef<T> = UnsafeWeakRef(this)
/** /**
* Provides a weak reference to [this]. * Provides a weak reference to [this].
* The `getValue` for delegation throws an [IllegalStateException] if the referent is released by GC. Therefore it returns notnull value only * The `getValue` for delegation throws an [IllegalStateException] if the referent is released by GC. Therefore it returns notnull value only
*
* **UNSTABLE API**: It is strongly suggested not to use this api
*/ */
fun <T> T.unsafeWeakRef(): UnsafeWeakRef<T> = UnsafeWeakRef(this.weakRef()) fun <T> T.unsafeWeakRef(): UnsafeWeakRef<T> = UnsafeWeakRef(this.weakRef())