Swam API Documentation0.6.0-RC3 < Back

Packages

package root
Definition Classes
root
package swam
Definition Classes
root
package binary
Definition Classes
swam
package cfg
Definition Classes
swam
package decompilation
Definition Classes
swam
package generator
Definition Classes
swam

This package contains all the classes and types related to running WebAssembly modules.

The entry point for almost all users will be Engine. A typical use of the engine is:

import swam._
import text._
import runtime._
import exports._

import cats.implicits._
import cats.effect._

import java.nio.file.Paths

val tcompiler = Compiler[IO]
val engine = Engine[IO]

for {
  tcompiler <- tcompiler
  engine <- engine
  mod <- engine.compile(/* source of the module */)
  inst <- mod.newInstance()
  f <- inst.exports.function1[Int, Int]("f")
  res <- f(43)
} yield res

println(res.unsafeRunSync())

Definition Classes: swam

package syntax
Instructions in this package are grouped by category as described in the specification.
Instructions in this package are grouped by category as described in the specification.
Definition Classes
swam
package text
Definition Classes
swam
package parser
package unresolved
Compiler
Def
ParserException
ResolutionException
Resolver
ResolverContext
TextCompilerException
WastPositioner
package traversal
Definition Classes
swam
package util
Definition Classes
swam
package validation
Definition Classes
swam

swam

text

package text

Source: package.scala

Linear Supertypes

AnyRef, Any

Ordering

Alphabetic
By Inheritance

Inherited

text
AnyRef
Any

Hide All
Show All

Visibility

Public
Protected

Package Members

package parser
package unresolved

Type Members

class Compiler[F[_]] extends AnyRef
case class Def(id: Id, pos: Int) extends Product with Serializable
class ParserException extends TextCompilerException
class ResolutionException extends TextCompilerException
class Resolver[F[_]] extends AnyRef
Implements text module resolution as per the specification.
Implements text module resolution as per the specification. All indices and names are checked for existence and replaced by the index in the loaded module.
case class ResolverContext(name: Id = NoId, types: Vector[Def] = Vector.empty, funcs: Vector[Def] = Vector.empty, tables: Vector[Def] = Vector.empty, mems: Vector[Def] = Vector.empty, globals: Vector[Def] = Vector.empty, locals: Vector[Def] = Vector.empty, labels: Vector[Def] = Vector.empty, typedefs: Vector[FuncType] = Vector.empty, localNames: Vector[Vector[Id]] = Vector.empty, importAllowed: Boolean = true) extends Product with Serializable
class TextCompilerException extends SwamException
class WastPositioner extends Positioner[TextFilePosition]
Loads the content of the file and renders a TextFilePosition.

Value Members

def readFile[F[_]](path: Path, blocker: Blocker, chunkSize: Int)(implicit F: Sync[F], cs: ContextShift[F]): F[String]
object Compiler

Packages

text

package text

Package Members

Type Members

Value Members

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

text

package text

Package Members

Type Members

Value Members

Inherited from AnyRef

Inherited from Any

Ungrouped

text