net.bjoernpetersen.musicbot.spi.loader.Resource.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of musicbot Show documentation

Core library of MusicBot, which plays music from various providers.

There is a newer version: 0.25.0

package net.bjoernpetersen.musicbot.spi.loader

/**
 * A resource that is allocated when a song is loaded and needs to be deallocated at some point.
 *
 * One resource object may be reused any number of times as long as it is [valid][isValid]
 */
interface Resource {

    /**
     * Free this resource.
     *
     * Future [isValid] calls should never return `true` again.
     * This means you should introduce an `isFreed` field to short-circuit [isValid].
     *
     */
    suspend fun free()

    /**
     * Checks whether this resource is still valid and can be used.
     *
     * For example: a file resource may check whether the file still exists
     */
    val isValid: Boolean
}