wasi/org.kowasm.wasi

Package-level declarations

Package for WASI public API.

Types

data class DateTime(val seconds: Long, val nanoseconds: Int)

A time and date in seconds plus nanoseconds.

DefaultMonotonicClock

object DefaultMonotonicClock : MonotonicClock

Default monotonic clock, suitable for general-purpose application needs.

DefaultWallClock

object DefaultWallClock : WallClock

Default wall clock, suitable for general-purpose application needs.

object DefaultWasiCli : WasiCli

Default implementation of WasiCli.

DefaultWasiFilesystem

object DefaultWasiFilesystem : WasiFileSystem

typealias Descriptor = Int

A descriptor is a reference to a filesystem object, which may be a file, directory, named pipe, special file, or other object on which filesystem calls may be made.

DescriptorFlags

data class DescriptorFlags(val read: Boolean = false, val write: Boolean = false, val nonBlocking: Boolean = false, val fileIntegritySync: Boolean = false, val dataIntegritySync: Boolean = false, val requestedWriteSync: Boolean = false, val mutateDirectory: Boolean = true)

Descriptor flags.

enum DescriptorType : Enum<DescriptorType>

The type of a filesystem object referenced by a descriptor.

data class DirectoryEntry(val inode: INode?, val type: DescriptorType, val name: String)

A directory entry.

enum ErrorCode : Enum<ErrorCode>

Error codes returned by functions. Not all of these error codes are returned by the functions provided by this API; some are used in higher-level library layers, and others are provided merely for alignment with POSIX.

object ErrorWasiPrint : WasiPrint

typealias Filesize = ULong

File size or length of a region within a file.

typealias INode = ULong

Filesystem object serial number that is unique within its file system.

typealias Instant = Long

A timestamp in nanoseconds.

data class Modes(val readable: Boolean = false, val writeable: Boolean = false, val executable: Boolean = false)

Permissions mode used by openAt, changeFilePermissionsAt, and similar.

interface MonotonicClock

A monotonic clock is a clock which has an unspecified initial value, and successive reads of the clock will produce non-decreasing values.

interface MonotonicTimer

This is a timer that counts down from a given starting time down to zero on a monotonic clock.

data class OpenFlags(val create: Boolean = false, val directory: Boolean = false, val exclude: Boolean = false, val truncate: Boolean = false)

Open flags used by openAt.

OutputWasiPrint

object OutputWasiPrint : WasiPrint

data class PathFlags(val symlinkFollow: Boolean)

Flags determining the method of how paths are resolved.

data class ReadResult(val data: ByteArray, val eof: Boolean)

Result of a read operation.

SecureWasiRandom

class SecureWasiRandom : Random

Provide a secure random generator implemented via WASI.

StandardDescriptor

object StandardDescriptor

Standard descriptors.

interface WallClock

A wall clock is a clock which measures the date and time according to some external reference.

object Wasi : WasiFileSystem, WasiCli

Provides access to WASI APIs.

interface WasiCli

Provides access to the command line arguments and environment variables.

class WasiException(val errorCode: Int) : RuntimeException

Thrown when a WASI call fails. TODO Introduce an ErrorCode enum based on the one from wasi-filesystem

interface WasiFileSystem

interface WasiPrint

Functions

SeededWasiRandom

fun SeededWasiRandom(): Random

Provide a pseudo random generator seeded by a Long value generated via WASI.