server

package
v0.26.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 16, 2022 License: Apache-2.0 Imports: 30 Imported by: 0

Documentation

Index

Constants

View Source 
const GetContractInitializerParametersCommand = "cadence.server.getContractInitializerParameters"
View Source 
const GetEntryPointParametersCommand = "cadence.server.getEntryPointParameters"
View Source 
const ParseEntryPointArgumentsCommand = "cadence.server.parseEntryPointArguments"

Variables

This section is empty.

Functions

func CheckCommandArgumentCount added in v0.12.3 

func CheckCommandArgumentCount(args []json.RawMessage, expectedCount int) error

Types

type AddressContractNamesResolver added in v0.12.4 

type AddressContractNamesResolver func(address common.Address) ([]string, error)

AddressContractNamesResolver is a function that is used to resolve contract names of an address

type AddressImportResolver added in v0.7.0 

type AddressImportResolver func(location common.AddressLocation) (string, error)

AddressImportResolver is a function that is used to resolve address imports

type CadenceCheckCompletedParams added in v0.12.3 

type CadenceCheckCompletedParams struct {

	/*URI defined:
	 * The URI which was checked.
	 */
	URI protocol.DocumentURI `json:"uri"`

	Valid bool `json:"valid"`
}

type CodeLensProvider added in v0.7.0 

type CodeLensProvider func(uri protocol.DocumentURI, version int32, checker *sema.Checker) ([]*protocol.CodeLens, error)

CodeLensProvider is a function that is used to provide code lenses for the given checker

type Command added in v0.7.0 

type Command struct {
	Name    string
	Handler CommandHandler
}

type CommandHandler 

type CommandHandler func(args ...json2.RawMessage) (interface{}, error)

CommandHandler represents the form of functions that handle commands submitted from the client using workspace/executeCommand.

type CompletionItemData added in v0.7.0 

type CompletionItemData struct {
	URI protocol.DocumentURI `json:"uri"`
	ID  string               `json:"id"`
}

type DiagnosticProvider added in v0.7.0 

type DiagnosticProvider func(uri protocol.DocumentURI, version int32, checker *sema.Checker) ([]protocol.Diagnostic, error)

DiagnosticProvider is a function that is used to provide diagnostics for the given checker

type Document added in v0.7.0 

type Document struct {
	Text    string
	Version int32
}

Document represents an open document on the client. It contains all cached information about each document that is used to support CodeLens, transaction submission, and script execution.

func (Document) HasAnyPrecedingStringsAtPosition added in v0.8.0 

func (d Document) HasAnyPrecedingStringsAtPosition(options []string, line, column int) bool

func (Document) Offset added in v0.8.0 

func (d Document) Offset(line, column int) (offset int)

type DocumentSymbolProvider added in v0.18.0 

type DocumentSymbolProvider func(uri protocol.DocumentURI, version int32, checker *sema.Checker) ([]*protocol.DocumentSymbol, error)

DocumentSymbolProvider is a function that is used to provide document symbols for the given checker

type InitializationOptionsHandler added in v0.7.0 

type InitializationOptionsHandler func(initializationOptions any) error

InitializationOptionsHandler is a function that is used to handle initialization options sent by the client

type ObjectStream added in v0.7.0 

type ObjectStream struct {
	// contains filtered or unexported fields
}

func NewObjectStream added in v0.7.0 

func NewObjectStream(
	writeObject func(obj any) error,
	readObject func(v any) error,
	close func() error,
) ObjectStream

func (ObjectStream) Close added in v0.7.0 

func (o ObjectStream) Close() error

func (ObjectStream) ReadObject added in v0.7.0 

func (o ObjectStream) ReadObject(v any) (err error)

func (ObjectStream) WriteObject added in v0.7.0 

func (o ObjectStream) WriteObject(obj any) error

type Option added in v0.7.0 

type Option func(*Server) error

func WithAddressContractNamesResolver added in v0.12.4 

func WithAddressContractNamesResolver(resolver AddressContractNamesResolver) Option

WithAddressContractNamesResolver returns a server option that sets the given function as the function that is used to resolve contract names of an address

func WithAddressImportResolver added in v0.7.0 

func WithAddressImportResolver(resolver AddressImportResolver) Option

WithAddressImportResolver returns a server option that sets the given function as the function that is used to resolve address imports

func WithCodeLensProvider added in v0.7.0 

func WithCodeLensProvider(provider CodeLensProvider) Option

WithCodeLensProvider returns a server option that adds the given function as a function that is used to generate code lenses

func WithCommand added in v0.7.0 

func WithCommand(command Command) Option

WithCommand returns a server options that adds the given command to the set of commands provided by the server to the client.

If a command with the given name already exists, the option fails.

func WithDiagnosticProvider added in v0.7.0 

func WithDiagnosticProvider(provider DiagnosticProvider) Option

WithDiagnosticProvider returns a server option that adds the given function as a function that is used to generate diagnostics

func WithInitializationOptionsHandler added in v0.7.0 

func WithInitializationOptionsHandler(handler InitializationOptionsHandler) Option

WithInitializationOptionsHandler returns a server option that adds the given function as a function that is used to handle initialization options sent by the client

func WithStringImportResolver added in v0.7.0 

func WithStringImportResolver(resolver StringImportResolver) Option

WithStringImportResolver returns a server option that sets the given function as the function that is used to resolve string imports

type Parameter added in v0.12.3 

type Parameter struct {
	Name string `json:"name"`
	Type string `json:"type"`
}

type Server 

type Server struct {
	// contains filtered or unexported fields
}

func NewServer 

func NewServer() (*Server, error)

func (*Server) CodeAction added in v0.18.0 

func (s *Server) CodeAction(
	_ protocol.Conn,
	params *protocol.CodeActionParams,
) (
	codeActions []*protocol.CodeAction,
	err error,
)

func (*Server) CodeLens 

func (s *Server) CodeLens(
	_ protocol.Conn,
	params *protocol.CodeLensParams,
) (
	codeLenses []*protocol.CodeLens,
	err error,
)

CodeLens is called every time the document contents change and returns a list of actions to be injected into the source as inline buttons.

func (*Server) Completion added in v0.7.0 

func (s *Server) Completion(
	conn protocol.Conn,
	params *protocol.CompletionParams,
) (
	items []*protocol.CompletionItem,
	err error,
)

Completion is called to compute completion items at a given cursor position.

func (*Server) Definition 

func (s *Server) Definition(
	_ protocol.Conn,
	params *protocol.TextDocumentPositionParams,
) (
	*protocol.Location,
	error,
)

Definition finds the definition of the type at the given location.

func (*Server) DidChangeTextDocument 

func (s *Server) DidChangeTextDocument(
	conn protocol.Conn,
	params *protocol.DidChangeTextDocumentParams,
) error

DidChangeTextDocument is called whenever the current document changes. We parse and check the text and publish diagnostics about the document.

func (*Server) DidOpenTextDocument 

func (s *Server) DidOpenTextDocument(conn protocol.Conn, params *protocol.DidOpenTextDocumentParams) error

DidOpenTextDocument is called whenever a new file is opened. We parse and check the text and publish diagnostics about the document.

func (*Server) DocumentHighlight added in v0.18.0 

func (s *Server) DocumentHighlight(
	_ protocol.Conn,
	params *protocol.TextDocumentPositionParams,
) (
	[]*protocol.DocumentHighlight,
	error,
)
func (s *Server) DocumentLink(
	_ protocol.Conn,
	_ *protocol.DocumentLinkParams,
) (
	symbols []*protocol.DocumentLink,
	err error,
)

func (*Server) DocumentSymbol added in v0.18.0 

func (s *Server) DocumentSymbol(
	_ protocol.Conn,
	params *protocol.DocumentSymbolParams,
) (
	symbols []*protocol.DocumentSymbol,
	err error,
)

DocumentSymbol is called every time the document contents change and returns a tree of known document symbols, which can be shown in outline panel

func (*Server) ExecuteCommand 

func (s *Server) ExecuteCommand(conn protocol.Conn, params *protocol.ExecuteCommandParams) (any, error)

ExecuteCommand is called to execute a custom, server-defined command.

We register all the commands we support in registerCommands and populate their corresponding handler at server initialization.

func (*Server) Exit 

func (*Server) Exit(_ protocol.Conn) error

Exit exits the process.

func (*Server) GetDocument added in v0.7.0 

func (s *Server) GetDocument(uri protocol.DocumentURI) (doc Document, ok bool)

func (*Server) Hover 

func (s *Server) Hover(
	_ protocol.Conn,
	params *protocol.TextDocumentPositionParams,
) (*protocol.Hover, error)

Hover returns contextual type information about the variable at the given location.

func (*Server) Initialize 

func (s *Server) Initialize(
	conn protocol.Conn,
	params *protocol.InitializeParams,
) (
	*protocol.InitializeResult,
	error,
)

func (*Server) InlayHint added in v0.24.1 

func (s *Server) InlayHint(
	_ protocol.Conn,
	params *protocol.InlayHintParams,
) (
	inlayHints []*protocol.InlayHint,
	err error,
)

func (*Server) Rename added in v0.18.0 

func (s *Server) Rename(
	_ protocol.Conn,
	params *protocol.RenameParams,
) (
	*protocol.WorkspaceEdit,
	error,
)

func (*Server) ResolveCompletionItem added in v0.7.0 

func (s *Server) ResolveCompletionItem(
	_ protocol.Conn,
	item *protocol.CompletionItem,
) (
	result *protocol.CompletionItem,
	err error,
)

ResolveCompletionItem is called to compute completion items at a given cursor position.

func (*Server) SetOptions added in v0.7.0 

func (s *Server) SetOptions(options ...Option) error

func (*Server) Shutdown 

func (*Server) Shutdown(conn protocol.Conn) error

Shutdown tells the server to stop accepting any new requests. This can only be followed by a call to Exit, which exits the process.

func (*Server) SignatureHelp 

func (s *Server) SignatureHelp(
	conn protocol.Conn,
	params *protocol.TextDocumentPositionParams,
) (*protocol.SignatureHelp, error)

func (*Server) Start 

func (s *Server) Start(stream jsonrpc2.ObjectStream) <-chan struct{}

func (*Server) Stop added in v0.7.0 

func (s *Server) Stop() error

type StdinStdoutReadWriterCloser added in v0.7.0 

type StdinStdoutReadWriterCloser struct{}

StdinStdoutReadWriterCloser implements an io.ReadWriter and io.Closer around STDIN and STDOUT.

func (StdinStdoutReadWriterCloser) Close added in v0.7.0 

func (StdinStdoutReadWriterCloser) Close() error

Close closes STDIN and STDOUT.

func (StdinStdoutReadWriterCloser) Read added in v0.7.0 

func (StdinStdoutReadWriterCloser) Read(p []byte) (int, error)

Read reads from STDIN.

func (StdinStdoutReadWriterCloser) Write added in v0.7.0 

func (StdinStdoutReadWriterCloser) Write(p []byte) (int, error)

Write writes to STDOUT.

type StringImportResolver added in v0.7.0 

type StringImportResolver func(location common.StringLocation) (string, error)

StringImportResolver is a function that is used to resolve string imports

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.