apidef

Documentation

Index

• type API
  • func GetAPI(ad *msgp.Reader) (*API, error)
• type APIClass
• type APIFeature
• type APIFunction
• type APIFunctionParameter

Types

type API

type API struct {
	Types      []APIClass
	Functions  []APIFunction
	ErrorTypes []APIClass
	Features   []APIFeature
}

An API represents the API as advertised by Neovim

func GetAPI

func GetAPI(ad *msgp.Reader) (*API, error)

type APIClass

type APIClass struct {
	Name string
	Id   int
}

An APIClass represents a class as defined as part of the API

type APIFeature

type APIFeature struct {
	Name    string
	Methods []string
}

type APIFunction

type APIFunction struct {
	Name              string
	ReturnType        string
	ID                uint32
	CanFail           bool
	Deferred          bool
	ReceivesChannelID bool
	Parameters        []APIFunctionParameter
	Async             bool
}

An APIFunction represents a class as defined as part of the API

type APIFunctionParameter

type APIFunctionParameter struct {
	Type, Name string
}

An APIFunctionParameter represents a function parameters as defined by an APIFunction