jsii

README

The jsii runtime library for Go

This is the jsii runtime for go. This repository is used only for publishing the go module. The source code is managed in the main JSII repository. Refer to the go-runtime readme there for details on building and testing the module.

⚖ License

jsii is distributed under the Apache License, Version 2.0.

See LICENSE and NOTICE for more information.

Documentation

Overview

Package jsii provides the APIs used by code generated by the jsii-pacmak tool to interact with the @jsii/kernel process. It is not intended for users to directly interact with, and doing so could result in incorrect behavior.

Index

• func Bool(v bool) *bool
• func Bools(v ...bool) *[]*bool
• func Close()
• func Create(fqn FQN, args []interface{}, inst interface{})
• func Get(obj interface{}, property string, ret interface{})
• func InitJsiiProxy(ptr interface{})
• func Invoke(obj interface{}, method string, args []interface{}, ret interface{})
• func InvokeVoid(obj interface{}, method string, args []interface{})
• func Load(name string, version string, tarball []byte)
• func Number(v float64) *float64
• func Numbers(v ...float64) *[]*float64
• func RegisterClass(fqn FQN, class reflect.Type, members []Member, maker func() interface{})
• func RegisterEnum(fqn FQN, enum reflect.Type, members map[string]interface{})
• func RegisterInterface(fqn FQN, iface reflect.Type, members []Member, maker func() interface{})
• func RegisterStruct(fqn FQN, strct reflect.Type)
• func Set(obj interface{}, property string, value interface{})
• func StaticGet(fqn FQN, property string, ret interface{})
• func StaticInvoke(fqn FQN, method string, args []interface{}, ret interface{})
• func StaticInvokeVoid(fqn FQN, method string, args []interface{})
• func StaticSet(fqn FQN, property string, value interface{})
• func String(v string) *string
• func Strings(v ...string) *[]*string
• func Time(v time.Time) *time.Time
• func Times(v ...time.Time) *[]*time.Time
• type FQN
• type Member
• type MemberMethod
• type MemberProperty

Functions

func Bool

func Bool(v bool) *bool

Bool obtains a pointer to the provided bool.

func Bools

func Bools(v ...bool) *[]*bool

Bools obtains a pointer to a slice of pointers to all the provided booleans.

func Close

func Close()

Close finalizes the runtime process, signalling the end of the execution to the jsii kernel process, and waiting for graceful termination. The best practice is to defer call thins at the beginning of the "main" function.

If a jsii client is used *after* Close was called, a new jsii kernel process will be initialized, and Close should be called again to correctly finalize that, too. This behavior is intended for use in unit/integration tests.

func Create

func Create(fqn FQN, args []interface{}, inst interface{})

Create will construct a new JSII object within the kernel runtime. This is called by jsii object constructors.

func Get

func Get(obj interface{}, property string, ret interface{})

Get reads a property value on a given jsii class instance. The response should be decoded into the expected type of the property being read.

func InitJsiiProxy

func InitJsiiProxy(ptr interface{})

InitJsiiProxy initializes a jsii proxy instance at the provided pointer. Panics if the pointer cannot be initialized to a proxy instance (i.e: the element of it is not a registered jsii interface or class type).

func Invoke

func Invoke(obj interface{}, method string, args []interface{}, ret interface{})

Invoke will call a method on a jsii class instance. The response will be decoded into the expected return type for the method being called.

func InvokeVoid

func InvokeVoid(obj interface{}, method string, args []interface{})

InvokeVoid will call a void method on a jsii class instance.

func Load

func Load(name string, version string, tarball []byte)

Load ensures a npm package is loaded in the jsii kernel.

func Number

func Number(v float64) *float64

Number obtains a pointer to the provided float64.

func Numbers

func Numbers(v ...float64) *[]*float64

Numbers obtains a pointer to a slice of pointers to all the provided numbers.

func RegisterClass

func RegisterClass(fqn FQN, class reflect.Type, members []Member, maker func() interface{})

RegisterClass associates a class fully qualified name to the specified class interface, member list, and proxy maker function. Panics if class is not a go interface, or if the provided fqn was already used to register a different type.

func RegisterEnum

func RegisterEnum(fqn FQN, enum reflect.Type, members map[string]interface{})

RegisterEnum associates an enum's fully qualified name to the specified enum type, and members. Panics if enum is not a reflect.String type, any value in the provided members map is of a type other than enum, or if the provided fqn was already used to register a different type.

func RegisterInterface

func RegisterInterface(fqn FQN, iface reflect.Type, members []Member, maker func() interface{})

RegisterInterface associates an interface's fully qualified name to the specified interface type, member list, and proxy maker function. Panics if iface is not an interface, or if the provided fqn was already used to register a different type.

func RegisterStruct

func RegisterStruct(fqn FQN, strct reflect.Type)

RegisterStruct associates a struct's fully qualified name to the specified struct type. Panics if strct is not a struct, or if the provided fqn was already used to register a different type.

func Set

func Set(obj interface{}, property string, value interface{})

Set writes a property on a given jsii class instance. The value should match the type of the property being written, or the jsii kernel will crash.

func StaticGet

func StaticGet(fqn FQN, property string, ret interface{})

StaticGet reads a static property value on a given jsii class. The response should be decoded into the expected type of the property being read.

func StaticInvoke

func StaticInvoke(fqn FQN, method string, args []interface{}, ret interface{})

StaticInvoke will call a static method on a given jsii class. The response will be decoded into the expected return type for the method being called.

func StaticInvokeVoid

func StaticInvokeVoid(fqn FQN, method string, args []interface{})

StaticInvokeVoid will call a static void method on a given jsii class.

func StaticSet

func StaticSet(fqn FQN, property string, value interface{})

StaticSet writes a static property on a given jsii class. The value should match the type of the property being written, or the jsii kernel will crash.

func String

func String(v string) *string

String obtains a pointer to the provided string.

func Strings

func Strings(v ...string) *[]*string

Strings obtains a pointer to a slice of pointers to all the provided strings.

func Time

func Time(v time.Time) *time.Time

Time obtains a pointer to the provided time.Time.

func Times

func Times(v ...time.Time) *[]*time.Time

Times obtains a pointer to a slice of pointers to all the provided time.Time.

Types

type FQN

type FQN api.FQN

FQN represents a fully-qualified type name in the jsii type system.

type Member

type Member interface {
	// contains filtered or unexported methods
}

Member is a runtime descriptor for a class or interface member

type MemberMethod

type MemberMethod api.MethodOverride

MemberMethod is a runtime descriptor for a class method (implementation of Member)

type MemberProperty

type MemberProperty api.PropertyOverride

MemberProperty is a runtime descriptor for a class or interface property (implementation of Member)