varlinkdef

Documentation

Overview

Package varlinkdef implements the Varlink interface definition format.

See: https://varlink.org/Interface-Definition

Index

• Variables
• type Enum
• type Interface
  • func Read(r io.Reader) (*Interface, error)
• type Kind
  • func (kind Kind) String() string
• type Method
• type Struct
• type Type

Variables

var (
	TypeBool   = Type{Kind: KindBool}
	TypeInt    = Type{Kind: KindInt}
	TypeFloat  = Type{Kind: KindFloat}
	TypeString = Type{Kind: KindString}
	TypeObject = Type{Kind: KindObject}
)

Types

type Enum

type Enum []string

type Interface

type Interface struct {
	Name    string
	Types   map[string]Type // only KindStruct and KindEnum
	Methods map[string]Method
	Errors  map[string]Struct
}

func Read

func Read(r io.Reader) (*Interface, error)

type Kind

type Kind int

const (
	KindStruct Kind = iota + 1
	KindEnum
	KindName
	KindBool
	KindInt
	KindFloat
	KindString
	KindObject
	KindArray
	KindMap
)

func (Kind) String

func (kind Kind) String() string

type Method

type Method struct {
	In, Out Struct
}

type Struct

type Struct map[string]Type

type Type

type Type struct {
	Kind     Kind
	Nullable bool
	Inner    *Type  // for KindArray and KindMap
	Name     string // for KindName
	Struct   Struct // for KindStruct
	Enum     Enum   // for KindEnum
}