commonMain.io.polywrap.core.WrapPackage.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of polywrap-client Show documentation

Polywrap Client for JVM and Android

There is a newer version: 0.10.4

package io.polywrap.core

import io.polywrap.core.wrap.WrapManifest
import uniffi.polywrap_native.IffiWrapPackage

/**
 * A wrap package, capable of producing instances of a wrapper and its manifest
 */
interface WrapPackage : IffiWrapPackage {
    /**
     * Get a file from the Wrapper package.
     *
     * @param path The path to the file.
     * @return The result of the file retrieval.
     */
    fun getFile(path: String): Result

    /**
     * Produce an instance of the wrap manifest
     *
     * @return A Result containing the wrap manifest or an error
     */
    fun getManifest(): Result
}