gpyrpc

package
v0.11.0 Latest Latest
Warning

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

Go to latest
Published: Dec 19, 2024 License: Apache-2.0 Imports: 13 Imported by: 16

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PROTORPC_AcceptBuiltinServiceClient

func PROTORPC_AcceptBuiltinServiceClient(lis net.Listener, x PROTORPC_BuiltinService)

PROTORPC_AcceptBuiltinServiceClient accepts connections on the listener and serves requests for each incoming connection. Accept blocks; the caller typically invokes it in a go statement.

func PROTORPC_AcceptKclvmServiceClient

func PROTORPC_AcceptKclvmServiceClient(lis net.Listener, x PROTORPC_KclvmService)

PROTORPC_AcceptKclvmServiceClient accepts connections on the listener and serves requests for each incoming connection. Accept blocks; the caller typically invokes it in a go statement.

func PROTORPC_ListenAndServeBuiltinService

func PROTORPC_ListenAndServeBuiltinService(network, addr string, x PROTORPC_BuiltinService) error

PROTORPC_ListenAndServeBuiltinService listen announces on the local network address laddr and serves the given BuiltinService implementation.

func PROTORPC_ListenAndServeKclvmService

func PROTORPC_ListenAndServeKclvmService(network, addr string, x PROTORPC_KclvmService) error

PROTORPC_ListenAndServeKclvmService listen announces on the local network address laddr and serves the given KclvmService implementation.

func PROTORPC_NewBuiltinServiceServer

func PROTORPC_NewBuiltinServiceServer(x PROTORPC_BuiltinService) *rpc.Server

PROTORPC_NewBuiltinServiceServer returns a new PROTORPC_BuiltinService Server.

func PROTORPC_NewKclvmServiceServer

func PROTORPC_NewKclvmServiceServer(x PROTORPC_KclvmService) *rpc.Server

PROTORPC_NewKclvmServiceServer returns a new PROTORPC_KclvmService Server.

func PROTORPC_RegisterBuiltinService

func PROTORPC_RegisterBuiltinService(srv *rpc.Server, x PROTORPC_BuiltinService) error

PROTORPC_RegisterBuiltinService publish the given PROTORPC_BuiltinService implementation on the server.

func PROTORPC_RegisterKclvmService

func PROTORPC_RegisterKclvmService(srv *rpc.Server, x PROTORPC_KclvmService) error

PROTORPC_RegisterKclvmService publish the given PROTORPC_KclvmService implementation on the server.

func PROTORPC_ServeBuiltinService

func PROTORPC_ServeBuiltinService(conn io.ReadWriteCloser, x PROTORPC_BuiltinService)

PROTORPC_ServeBuiltinService serves the given PROTORPC_BuiltinService implementation.

func PROTORPC_ServeKclvmService

func PROTORPC_ServeKclvmService(conn io.ReadWriteCloser, x PROTORPC_KclvmService)

PROTORPC_ServeKclvmService serves the given PROTORPC_KclvmService implementation.

func RegisterKclvmServiceServer

func RegisterKclvmServiceServer(s *grpc.Server, srv KclvmServiceServer)

Types

type Argument added in v0.9.0

type Argument = api.Argument

Message representing a key-value argument for KCL. kcl main.k -D name=value

type BuildProgram_Args added in v0.8.0

type BuildProgram_Args = api.BuildProgram_Args

Message for build program request arguments.

type BuildProgram_Result added in v0.8.0

type BuildProgram_Result = api.BuildProgram_Result

Message for build program response.

type CliConfig

type CliConfig = api.CliConfig

Message representing KCL CLI configuration.

type Decorator

type Decorator = api.Decorator

Message representing a decorator in KCL.

type Error added in v0.7.3

type Error = api.Error

Message representing an error.

type Example added in v0.5.2

type Example = api.Example

Message representing an example in KCL.

type ExecArtifact_Args added in v0.8.0

type ExecArtifact_Args = api.ExecArtifact_Args

Message for execute artifact request arguments.

type ExecProgram_Args

type ExecProgram_Args = api.ExecProgram_Args

Message for execute program request arguments.

type ExecProgram_Result

type ExecProgram_Result = api.ExecProgram_Result

Message for execute program response.

type ExternalPkg added in v0.9.0

type ExternalPkg = api.ExternalPkg

Message representing an external package for KCL. kcl main.k -E pkg_name=pkg_path

type FormatCode_Args

type FormatCode_Args = api.FormatCode_Args

Message for format code request arguments.

type FormatCode_Result

type FormatCode_Result = api.FormatCode_Result

Message for format code response.

type FormatPath_Args

type FormatPath_Args = api.FormatPath_Args

Message for format file path request arguments.

type FormatPath_Result

type FormatPath_Result = api.FormatPath_Result

Message for format file path response.

type GetSchemaTypeMapping_Args

type GetSchemaTypeMapping_Args = api.GetSchemaTypeMapping_Args

Message for get schema type mapping request arguments.

type GetSchemaTypeMapping_Result

type GetSchemaTypeMapping_Result = api.GetSchemaTypeMapping_Result

Message for get schema type mapping response.

type GetVersion_Args added in v0.9.2

type GetVersion_Args = api.GetVersion_Args

Message for version request arguments. Empty message.

type GetVersion_Result added in v0.9.2

type GetVersion_Result = api.GetVersion_Result

Message for version response.

type KclType

type KclType = api.KclType

Message representing a KCL type.

type KclvmServiceServer

type KclvmServiceServer interface {
	// / Ping KclvmService, return the same value as the parameter
	// /
	// / # Examples
	// /
	// / “`jsonrpc
	// / // Request
	// / {
	// /     "jsonrpc": "2.0",
	// /     "method": "Ping",
	// /     "params": {
	// /         "value": "hello"
	// /     },
	// /     "id": 1
	// / }
	// /
	// / // Response
	// / {
	// /     "jsonrpc": "2.0",
	// /     "result": {
	// /         "value": "hello"
	// /     },
	// /     "id": 1
	// / }
	// / “`
	Ping(context.Context, *Ping_Args) (*Ping_Result, error)
	// / GetVersion KclvmService, return the kclvm service version information
	// /
	// / # Examples
	// /
	// / “`jsonrpc
	// / // Request
	// / {
	// /     "jsonrpc": "2.0",
	// /     "method": "GetVersion",
	// /     "params": {},
	// /     "id": 1
	// / }
	// /
	// / // Response
	// / {
	// /     "jsonrpc": "2.0",
	// /     "result": {
	// /         "version": "0.9.1",
	// /         "checksum": "c020ab3eb4b9179219d6837a57f5d323",
	// /         "git_sha": "1a9a72942fffc9f62cb8f1ae4e1d5ca32aa1f399",
	// /         "version_info": "Version: 0.9.1-c020ab3eb4b9179219d6837a57f5d323\nPlatform: aarch64-apple-darwin\nGitCommit: 1a9a72942fffc9f62cb8f1ae4e1d5ca32aa1f399"
	// /     },
	// /     "id": 1
	// / }
	// / “`
	GetVersion(context.Context, *GetVersion_Args) (*GetVersion_Result, error)
	// / Parse KCL program with entry files.
	// /
	// / # Examples
	// /
	// / “`jsonrpc
	// / // Request
	// / {
	// /     "jsonrpc": "2.0",
	// /     "method": "ParseProgram",
	// /     "params": {
	// /         "paths": ["./src/testdata/test.k"]
	// /     },
	// /     "id": 1
	// / }
	// /
	// / // Response
	// / {
	// /     "jsonrpc": "2.0",
	// /     "result": {
	// /         "ast_json": "{...}",
	// /         "paths": ["./src/testdata/test.k"],
	// /         "errors": []
	// /     },
	// /     "id": 1
	// / }
	// / “`
	ParseProgram(context.Context, *ParseProgram_Args) (*ParseProgram_Result, error)
	// / Parse KCL single file to Module AST JSON string with import dependencies
	// / and parse errors.
	// /
	// / # Examples
	// /
	// / “`jsonrpc
	// / // Request
	// / {
	// /     "jsonrpc": "2.0",
	// /     "method": "ParseFile",
	// /     "params": {
	// /         "path": "./src/testdata/parse/main.k"
	// /     },
	// /     "id": 1
	// / }
	// /
	// / // Response
	// / {
	// /     "jsonrpc": "2.0",
	// /     "result": {
	// /         "ast_json": "{...}",
	// /         "deps": ["./dep1", "./dep2"],
	// /         "errors": []
	// /     },
	// /     "id": 1
	// / }
	// / “`
	ParseFile(context.Context, *ParseFile_Args) (*ParseFile_Result, error)
	// / load_package provides users with the ability to parse kcl program and semantic model
	// / information including symbols, types, definitions, etc.
	// /
	// / # Examples
	// /
	// / “`jsonrpc
	// / // Request
	// / {
	// /     "jsonrpc": "2.0",
	// /     "method": "LoadPackage",
	// /     "params": {
	// /         "parse_args": {
	// /             "paths": ["./src/testdata/parse/main.k"]
	// /         },
	// /         "resolve_ast": true
	// /     },
	// /     "id": 1
	// / }
	// /
	// / // Response
	// / {
	// /     "jsonrpc": "2.0",
	// /     "result": {
	// /         "program": "{...}",
	// /         "paths": ["./src/testdata/parse/main.k"],
	// /         "parse_errors": [],
	// /         "type_errors": [],
	// /         "symbols": { ... },
	// /         "scopes": { ... },
	// /         "node_symbol_map": { ... },
	// /         "symbol_node_map": { ... },
	// /         "fully_qualified_name_map": { ... },
	// /         "pkg_scope_map": { ... }
	// /     },
	// /     "id": 1
	// / }
	// / “`
	LoadPackage(context.Context, *LoadPackage_Args) (*LoadPackage_Result, error)
	// / list_options provides users with the ability to parse kcl program and get all option information.
	// /
	// / # Examples
	// /
	// / “`jsonrpc
	// / // Request
	// / {
	// /     "jsonrpc": "2.0",
	// /     "method": "ListOptions",
	// /     "params": {
	// /         "paths": ["./src/testdata/option/main.k"]
	// /     },
	// /     "id": 1
	// / }
	// /
	// / // Response
	// / {
	// /     "jsonrpc": "2.0",
	// /     "result": {
	// /         "options": [
	// /             { "name": "option1", "type": "str", "required": true, "default_value": "", "help": "option 1 help" },
	// /             { "name": "option2", "type": "int", "required": false, "default_value": "0", "help": "option 2 help" },
	// /             { "name": "option3", "type": "bool", "required": false, "default_value": "false", "help": "option 3 help" }
	// /         ]
	// /     },
	// /     "id": 1
	// / }
	// / “`
	ListOptions(context.Context, *ParseProgram_Args) (*ListOptions_Result, error)
	// / list_variables provides users with the ability to parse kcl program and get all variables by specs.
	// /
	// / # Examples
	// /
	// / “`jsonrpc
	// / // Request
	// / {
	// /     "jsonrpc": "2.0",
	// /     "method": "ListVariables",
	// /     "params": {
	// /         "files": ["./src/testdata/variables/main.k"],
	// /         "specs": ["a"]
	// /     },
	// /     "id": 1
	// / }
	// /
	// / // Response
	// / {
	// /     "jsonrpc": "2.0",
	// /     "result": {
	// /         "variables": {
	// /             "a": {
	// /                 "variables": [
	// /                     { "value": "1", "type_name": "int", "op_sym": "", "list_items": [], "dict_entries": [] }
	// /                 ]
	// /             }
	// /         },
	// /         "unsupported_codes": [],
	// /         "parse_errors": []
	// /     },
	// /     "id": 1
	// / }
	// / “`
	ListVariables(context.Context, *ListVariables_Args) (*ListVariables_Result, error)
	// / Execute KCL file with args. **Note that it is not thread safe.**
	// /
	// / # Examples
	// /
	// / “`jsonrpc
	// / // Request
	// / {
	// /     "jsonrpc": "2.0",
	// /     "method": "ExecProgram",
	// /     "params": {
	// /         "work_dir": "./src/testdata",
	// /         "k_filename_list": ["test.k"]
	// /     },
	// /     "id": 1
	// / }
	// /
	// / // Response
	// / {
	// /     "jsonrpc": "2.0",
	// /     "result": {
	// /         "json_result": "{\"alice\": {\"age\": 18}}",
	// /         "yaml_result": "alice:\n  age: 18",
	// /         "log_message": "",
	// /         "err_message": ""
	// /     },
	// /     "id": 1
	// / }
	// /
	// / // Request with code
	// / {
	// /     "jsonrpc": "2.0",
	// /     "method": "ExecProgram",
	// /     "params": {
	// /         "k_filename_list": ["file.k"],
	// /         "k_code_list": ["alice = {age = 18}"]
	// /     },
	// /     "id": 2
	// / }
	// /
	// / // Response
	// / {
	// /     "jsonrpc": "2.0",
	// /     "result": {
	// /         "json_result": "{\"alice\": {\"age\": 18}}",
	// /         "yaml_result": "alice:\n  age: 18",
	// /         "log_message": "",
	// /         "err_message": ""
	// /     },
	// /     "id": 2
	// / }
	// /
	// / // Error case - cannot find file
	// / {
	// /     "jsonrpc": "2.0",
	// /     "method": "ExecProgram",
	// /     "params": {
	// /         "k_filename_list": ["invalid_file.k"]
	// /     },
	// /     "id": 3
	// / }
	// /
	// / // Error Response
	// / {
	// /     "jsonrpc": "2.0",
	// /     "error": {
	// /         "code": -32602,
	// /         "message": "Cannot find the kcl file"
	// /     },
	// /     "id": 3
	// / }
	// /
	// / // Error case - no input files
	// / {
	// /     "jsonrpc": "2.0",
	// /     "method": "ExecProgram",
	// /     "params": {
	// /         "k_filename_list": []
	// /     },
	// /     "id": 4
	// / }
	// /
	// / // Error Response
	// / {
	// /     "jsonrpc": "2.0",
	// /     "error": {
	// /         "code": -32602,
	// /         "message": "No input KCL files or paths"
	// /     },
	// /     "id": 4
	// / }
	// / “`
	ExecProgram(context.Context, *ExecProgram_Args) (*ExecProgram_Result, error)
	// / Build the KCL program to an artifact.
	// /
	// / # Examples
	// /
	// / “`jsonrpc
	// / // Request
	// / {
	// /     "jsonrpc": "2.0",
	// /     "method": "BuildProgram",
	// /     "params": {
	// /         "exec_args": {
	// /             "work_dir": "./src/testdata",
	// /             "k_filename_list": ["test.k"]
	// /         },
	// /         "output": "./build"
	// /     },
	// /     "id": 1
	// / }
	// /
	// / // Response
	// / {
	// /     "jsonrpc": "2.0",
	// /     "result": {
	// /         "path": "./build/test.k"
	// /     },
	// /     "id": 1
	// / }
	// / “`
	// Depreciated: Please use the env.EnableFastEvalMode() and c.ExecuteProgram method and will be removed in v0.11.0.
	BuildProgram(context.Context, *BuildProgram_Args) (*BuildProgram_Result, error)
	// / Execute the KCL artifact with args. **Note that it is not thread safe.**
	// /
	// / # Examples
	// /
	// / “`jsonrpc
	// / // Request
	// / {
	// /     "jsonrpc": "2.0",
	// /     "method": "ExecArtifact",
	// /     "params": {
	// /         "path": "./artifact_path",
	// /         "exec_args": {
	// /             "work_dir": "./src/testdata",
	// /             "k_filename_list": ["test.k"]
	// /         }
	// /     },
	// /     "id": 1
	// / }
	// /
	// / // Response
	// / {
	// /     "jsonrpc": "2.0",
	// /     "result": {
	// /         "json_result": "{\"alice\": {\"age\": 18}}",
	// /         "yaml_result": "alice:\n  age: 18",
	// /         "log_message": "",
	// /         "err_message": ""
	// /     },
	// /     "id": 1
	// / }
	// / “`
	// Depreciated: Please use the env.EnableFastEvalMode() and c.ExecuteProgram method and will be removed in v0.11.0.
	ExecArtifact(context.Context, *ExecArtifact_Args) (*ExecProgram_Result, error)
	// / Override KCL file with args.
	// /
	// / # Examples
	// /
	// / “`jsonrpc
	// / // Request
	// / {
	// /     "jsonrpc": "2.0",
	// /     "method": "OverrideFile",
	// /     "params": {
	// /         "file": "./src/testdata/test.k",
	// /         "specs": ["alice.age=18"]
	// /     },
	// /     "id": 1
	// / }
	// /
	// / // Response
	// / {
	// /     "jsonrpc": "2.0",
	// /     "result": {
	// /         "result": true,
	// /         "parse_errors": []
	// /     },
	// /     "id": 1
	// / }
	// / “`
	OverrideFile(context.Context, *OverrideFile_Args) (*OverrideFile_Result, error)
	// / Get schema type mapping.
	// /
	// / # Examples
	// /
	// / “`jsonrpc
	// / // Request
	// / {
	// /     "jsonrpc": "2.0",
	// /     "method": "GetSchemaTypeMapping",
	// /     "params": {
	// /         "exec_args": {
	// /             "work_dir": "./src/testdata",
	// /             "k_filename_list": ["main.k"],
	// /             "external_pkgs": [
	// /                 {
	// /                     "pkg_name":"pkg",
	// /                     "pkg_path": "./src/testdata/pkg"
	// /                 }
	// /             ]
	// /         },
	// /         "schema_name": "Person"
	// /     },
	// /     "id": 1
	// / }
	// /
	// / // Response
	// / {
	// /     "jsonrpc": "2.0",
	// /     "result": {
	// /         "schema_type_mapping": {
	// /             "Person": {
	// /                 "type": "schema",
	// /                 "schema_name": "Person",
	// /                 "properties": {
	// /                     "name": { "type": "str" },
	// /                     "age": { "type": "int" }
	// /                 },
	// /                 "required": ["name", "age"],
	// /                 "decorators": []
	// /             }
	// /         }
	// /     },
	// /     "id": 1
	// / }
	// / “`
	GetSchemaTypeMapping(context.Context, *GetSchemaTypeMapping_Args) (*GetSchemaTypeMapping_Result, error)
	// / Format code source.
	// /
	// / # Examples
	// /
	// / “`jsonrpc
	// / // Request
	// / {
	// /     "jsonrpc": "2.0",
	// /     "method": "FormatCode",
	// /     "params": {
	// /         "source": "schema Person {\n    name: str\n    age: int\n}\nperson = Person {\n    name = \"Alice\"\n    age = 18\n}\n"
	// /     },
	// /     "id": 1
	// / }
	// /
	// / // Response
	// / {
	// /     "jsonrpc": "2.0",
	// /     "result": {
	// /         "formatted": "schema Person {\n    name: str\n    age: int\n}\nperson = Person {\n    name = \"Alice\"\n    age = 18\n}\n"
	// /     },
	// /     "id": 1
	// / }
	// / “`
	FormatCode(context.Context, *FormatCode_Args) (*FormatCode_Result, error)
	// / Format KCL file or directory path contains KCL files and returns the changed file paths.
	// /
	// / # Examples
	// /
	// / “`jsonrpc
	// / // Request
	// / {
	// /     "jsonrpc": "2.0",
	// /     "method": "FormatPath",
	// /     "params": {
	// /         "path": "./src/testdata/test.k"
	// /     },
	// /     "id": 1
	// / }
	// /
	// / // Response
	// / {
	// /     "jsonrpc": "2.0",
	// /     "result": {
	// /         "changed_paths": []
	// /     },
	// /     "id": 1
	// / }
	// / “`
	FormatPath(context.Context, *FormatPath_Args) (*FormatPath_Result, error)
	// / Lint files and return error messages including errors and warnings.
	// /
	// / # Examples
	// /
	// / “`jsonrpc
	// / // Request
	// / {
	// /     "jsonrpc": "2.0",
	// /     "method": "LintPath",
	// /     "params": {
	// /         "paths": ["./src/testdata/test-lint.k"]
	// /     },
	// /     "id": 1
	// / }
	// /
	// / // Response
	// / {
	// /     "jsonrpc": "2.0",
	// /     "result": {
	// /         "results": ["Module 'math' imported but unused"]
	// /     },
	// /     "id": 1
	// / }
	// / “`
	LintPath(context.Context, *LintPath_Args) (*LintPath_Result, error)
	// / Validate code using schema and data strings.
	// /
	// / **Note that it is not thread safe.**
	// /
	// / # Examples
	// /
	// / “`jsonrpc
	// / // Request
	// / {
	// /     "jsonrpc": "2.0",
	// /     "method": "ValidateCode",
	// /     "params": {
	// /         "code": "schema Person {\n    name: str\n    age: int\n    check: 0 < age < 120\n}",
	// /         "data": "{\"name\": \"Alice\", \"age\": 10}"
	// /     },
	// /     "id": 1
	// / }
	// /
	// / // Response
	// / {
	// /     "jsonrpc": "2.0",
	// /     "result": {
	// /         "success": true,
	// /         "err_message": ""
	// /     },
	// /     "id": 1
	// / }
	// / “`
	ValidateCode(context.Context, *ValidateCode_Args) (*ValidateCode_Result, error)
	ListDepFiles(context.Context, *ListDepFiles_Args) (*ListDepFiles_Result, error)
	// / Build setting file config from args.
	// /
	// / # Examples
	// /
	// /
	// / // Request
	// / {
	// /     "jsonrpc": "2.0",
	// /     "method": "LoadSettingsFiles",
	// /     "params": {
	// /         "work_dir": "./src/testdata/settings",
	// /         "files": ["./src/testdata/settings/kcl.yaml"]
	// /     },
	// /     "id": 1
	// / }
	// /
	// / // Response
	// / {
	// /     "jsonrpc": "2.0",
	// /     "result": {
	// /         "kcl_cli_configs": {
	// /             "files": ["./src/testdata/settings/kcl.yaml"],
	// /             "output": "",
	// /             "overrides": [],
	// /             "path_selector": [],
	// /             "strict_range_check": false,
	// /             "disable_none": false,
	// /             "verbose": 0,
	// /             "debug": false,
	// /             "sort_keys": false,
	// /             "show_hidden": false,
	// /             "include_schema_type_path": false,
	// /             "fast_eval": false
	// /         },
	// /         "kcl_options": []
	// /     },
	// /     "id": 1
	// / }
	// / “`
	LoadSettingsFiles(context.Context, *LoadSettingsFiles_Args) (*LoadSettingsFiles_Result, error)
	// / Rename all the occurrences of the target symbol in the files. This API will rewrite files if they contain symbols to be renamed.
	// / Return the file paths that got changed.
	// /
	// / # Examples
	// /
	// /
	// / // Request
	// / {
	// /     "jsonrpc": "2.0",
	// /     "method": "Rename",
	// /     "params": {
	// /         "package_root": "./src/testdata/rename_doc",
	// /         "symbol_path": "a",
	// /         "file_paths": ["./src/testdata/rename_doc/main.k"],
	// /         "new_name": "a2"
	// /     },
	// /     "id": 1
	// / }
	// /
	// / // Response
	// / {
	// /     "jsonrpc": "2.0",
	// /     "result": {
	// /         "changed_files": ["./src/testdata/rename_doc/main.k"]
	// /     },
	// /     "id": 1
	// / }
	// / “`
	Rename(context.Context, *Rename_Args) (*Rename_Result, error)
	// / Rename all the occurrences of the target symbol and return the modified code if any code has been changed. This API won't rewrite files but return the changed code.
	// /
	// / # Examples
	// /
	// /
	// / // Request
	// / {
	// /     "jsonrpc": "2.0",
	// /     "method": "RenameCode",
	// /     "params": {
	// /         "package_root": "/mock/path",
	// /         "symbol_path": "a",
	// /         "source_codes": {
	// /             "/mock/path/main.k": "a = 1\nb = a"
	// /         },
	// /         "new_name": "a2"
	// /     },
	// /     "id": 1
	// / }
	// /
	// / // Response
	// / {
	// /     "jsonrpc": "2.0",
	// /     "result": {
	// /         "changed_codes": {
	// /             "/mock/path/main.k": "a2 = 1\nb = a2"
	// /         }
	// /     },
	// /     "id": 1
	// / }
	// / “`
	RenameCode(context.Context, *RenameCode_Args) (*RenameCode_Result, error)
	// / Test KCL packages with test arguments.
	// /
	// / # Examples
	// /
	// /
	// / // Request
	// / {
	// /     "jsonrpc": "2.0",
	// /     "method": "Test",
	// /     "params": {
	// /         "exec_args": {
	// /             "work_dir": "./src/testdata/testing/module",
	// /             "k_filename_list": ["main.k"]
	// /         },
	// /         "pkg_list": ["./src/testdata/testing/module/..."]
	// /     },
	// /     "id": 1
	// / }
	// /
	// / // Response
	// / {
	// /     "jsonrpc": "2.0",
	// /     "result": {
	// /         "info": [
	// /             {"name": "test_case_1", "error": "", "duration": 1000, "log_message": ""},
	// /             {"name": "test_case_2", "error": "some error", "duration": 2000, "log_message": ""}
	// /         ]
	// /     },
	// /     "id": 1
	// / }
	// / “`
	Test(context.Context, *Test_Args) (*Test_Result, error)
	// / Download and update dependencies defined in the kcl.mod file.
	// /
	// / # Examples
	// /
	// /
	// / // Request
	// / {
	// /     "jsonrpc": "2.0",
	// /     "method": "UpdateDependencies",
	// /     "params": {
	// /         "manifest_path": "./src/testdata/update_dependencies"
	// /     },
	// /     "id": 1
	// / }
	// /
	// / // Response
	// / {
	// /     "jsonrpc": "2.0",
	// /     "result": {
	// /         "external_pkgs": [
	// /             {"pkg_name": "pkg1", "pkg_path": "./src/testdata/update_dependencies/pkg1"}
	// /         ]
	// /     },
	// /     "id": 1
	// / }
	// /
	// / // Request with vendor flag
	// / {
	// /     "jsonrpc": "2.0",
	// /     "method": "UpdateDependencies",
	// /     "params": {
	// /         "manifest_path": "./src/testdata/update_dependencies",
	// /         "vendor": true
	// /     },
	// /     "id": 2
	// / }
	// /
	// / // Response
	// / {
	// /     "jsonrpc": "2.0",
	// /     "result": {
	// /         "external_pkgs": [
	// /             {"pkg_name": "pkg1", "pkg_path": "./src/testdata/update_dependencies/pkg1"}
	// /         ]
	// /     },
	// /     "id": 2
	// / }
	// / “`
	UpdateDependencies(context.Context, *UpdateDependencies_Args) (*UpdateDependencies_Result, error)
}

KclvmServiceServer is the server API for KclvmService service.

type KeyValuePair

type KeyValuePair = api.KeyValuePair

Message representing a key-value pair.

type LintPath_Args

type LintPath_Args = api.LintPath_Args

Message for lint file path request arguments.

type LintPath_Result

type LintPath_Result = api.LintPath_Result

Message for lint file path response.

type ListDepFiles_Args

type ListDepFiles_Args = api.ListDepFiles_Args

Message for list dependency files request arguments.

type ListDepFiles_Result

type ListDepFiles_Result = api.ListDepFiles_Result

Message for list dependency files response.

type ListMethod_Args

type ListMethod_Args = api.ListMethod_Args

Message for list method request arguments. Empty message.

type ListMethod_Result

type ListMethod_Result = api.ListMethod_Result

Message for list method response.

type ListOptions_Result added in v0.8.1

type ListOptions_Result = api.ListOptions_Result

Message for list options response.

type ListVariables_Args added in v0.8.4

type ListVariables_Args = api.ListVariables_Args

Message for list variables request arguments.

type ListVariables_Options added in v0.9.0

type ListVariables_Options = api.ListVariables_Options

Message for list variables options.

type ListVariables_Result added in v0.8.4

type ListVariables_Result = api.ListVariables_Result

Message for list variables response.

type LoadPackage_Args added in v0.7.5

type LoadPackage_Args = api.LoadPackage_Args

Message for load package request arguments.

type LoadPackage_Result added in v0.7.5

type LoadPackage_Result = api.LoadPackage_Result

Message for load package response.

type LoadSettingsFiles_Args

type LoadSettingsFiles_Args = api.LoadSettingsFiles_Args

Message for load settings files request arguments.

type LoadSettingsFiles_Result

type LoadSettingsFiles_Result = api.LoadSettingsFiles_Result

Message for load settings files response.

type MapEntry added in v0.9.0

type MapEntry = api.MapEntry

Message representing a map entry.

type Message added in v0.7.3

type Message = api.Message

Message representing a detailed error message with a position.

type OptionHelp added in v0.8.1

type OptionHelp = api.OptionHelp

Message representing a help option.

type OverrideFile_Args

type OverrideFile_Args = api.OverrideFile_Args

Message for override file request arguments.

type OverrideFile_Result

type OverrideFile_Result = api.OverrideFile_Result

Message for override file response.

type PROTORPC_BuiltinService

type PROTORPC_BuiltinService interface {
	Ping(in *Ping_Args, out *Ping_Result) error
	ListMethod(in *ListMethod_Args, out *ListMethod_Result) error
}

type PROTORPC_BuiltinServiceClient

type PROTORPC_BuiltinServiceClient struct {
	*rpc.Client
}

func PROTORPC_DialBuiltinService

func PROTORPC_DialBuiltinService(network, addr string) (*PROTORPC_BuiltinServiceClient, error)

PROTORPC_DialBuiltinService connects to an PROTORPC_BuiltinService at the specified network address.

func PROTORPC_DialBuiltinServiceTimeout

func PROTORPC_DialBuiltinServiceTimeout(network, addr string, timeout time.Duration) (*PROTORPC_BuiltinServiceClient, error)

PROTORPC_DialBuiltinServiceTimeout connects to an PROTORPC_BuiltinService at the specified network address.

func PROTORPC_NewBuiltinServiceClient

func PROTORPC_NewBuiltinServiceClient(conn io.ReadWriteCloser) *PROTORPC_BuiltinServiceClient

PROTORPC_NewBuiltinServiceClient returns a PROTORPC_BuiltinService stub to handle requests to the set of PROTORPC_BuiltinService at the other end of the connection.

func (*PROTORPC_BuiltinServiceClient) AsyncListMethod

func (c *PROTORPC_BuiltinServiceClient) AsyncListMethod(in *ListMethod_Args, out *ListMethod_Result, done chan *rpc.Call) *rpc.Call

func (*PROTORPC_BuiltinServiceClient) AsyncPing

func (c *PROTORPC_BuiltinServiceClient) AsyncPing(in *Ping_Args, out *Ping_Result, done chan *rpc.Call) *rpc.Call

func (*PROTORPC_BuiltinServiceClient) ListMethod

func (*PROTORPC_BuiltinServiceClient) Ping

func (c *PROTORPC_BuiltinServiceClient) Ping(in *Ping_Args) (out *Ping_Result, err error)

type PROTORPC_KclvmService

type PROTORPC_KclvmService interface {
	Ping(in *Ping_Args, out *Ping_Result) error
	ExecProgram(in *ExecProgram_Args, out *ExecProgram_Result) error
	// Depreciated: Please use the env.EnableFastEvalMode() and c.ExecuteProgram method and will be removed in v0.11.0.
	BuildProgram(in *BuildProgram_Args, out *BuildProgram_Result) error
	// Depreciated: Please use the env.EnableFastEvalMode() and c.ExecuteProgram method and will be removed in v0.11.0.
	ExecArtifact(in *ExecArtifact_Args, out *ExecProgram_Result) error
	ParseProgram(in *ParseProgram_Args, out *ParseProgram_Result) error
	ListOptions(in *ParseProgram_Args, out *ListOptions_Result) error
	ListVariables(in *ListVariables_Args, out *ListVariables_Result) error
	LoadPackage(in *LoadPackage_Args, out *LoadPackage_Result) error
	FormatCode(in *FormatCode_Args, out *FormatCode_Result) error
	FormatPath(in *FormatPath_Args, out *FormatPath_Result) error
	LintPath(in *LintPath_Args, out *LintPath_Result) error
	OverrideFile(in *OverrideFile_Args, out *OverrideFile_Result) error
	GetSchemaTypeMapping(in *GetSchemaTypeMapping_Args, out *GetSchemaTypeMapping_Result) error
	ValidateCode(in *ValidateCode_Args, out *ValidateCode_Result) error
	ListDepFiles(in *ListDepFiles_Args, out *ListDepFiles_Result) error
	LoadSettingsFiles(in *LoadSettingsFiles_Args, out *LoadSettingsFiles_Result) error
	Rename(in *Rename_Args, out *Rename_Result) error
	RenameCode(in *RenameCode_Args, out *RenameCode_Result) error
	Test(in *Test_Args, out *Test_Result) error
	UpdateDependencies(in *UpdateDependencies_Args, out *UpdateDependencies_Result) error
	GetVersion(in *GetVersion_Args, out *GetVersion_Result) error
}

type PROTORPC_KclvmServiceClient

type PROTORPC_KclvmServiceClient struct {
	*rpc.Client
}

func PROTORPC_DialKclvmService

func PROTORPC_DialKclvmService(network, addr string) (*PROTORPC_KclvmServiceClient, error)

PROTORPC_DialKclvmService connects to an PROTORPC_KclvmService at the specified network address.

func PROTORPC_DialKclvmServiceTimeout

func PROTORPC_DialKclvmServiceTimeout(network, addr string, timeout time.Duration) (*PROTORPC_KclvmServiceClient, error)

PROTORPC_DialKclvmServiceTimeout connects to an PROTORPC_KclvmService at the specified network address.

func PROTORPC_NewKclvmServiceClient

func PROTORPC_NewKclvmServiceClient(conn io.ReadWriteCloser) *PROTORPC_KclvmServiceClient

PROTORPC_NewKclvmServiceClient returns a PROTORPC_KclvmService stub to handle requests to the set of PROTORPC_KclvmService at the other end of the connection.

func (*PROTORPC_KclvmServiceClient) AsyncBuildProgram added in v0.8.0

func (c *PROTORPC_KclvmServiceClient) AsyncBuildProgram(in *BuildProgram_Args, out *BuildProgram_Result, done chan *rpc.Call) *rpc.Call

Depreciated: Please use the env.EnableFastEvalMode() and c.ExecuteProgram method and will be removed in v0.11.0.

func (*PROTORPC_KclvmServiceClient) AsyncExecArtifact added in v0.8.0

func (c *PROTORPC_KclvmServiceClient) AsyncExecArtifact(in *ExecArtifact_Args, out *ExecProgram_Result, done chan *rpc.Call) *rpc.Call

Depreciated: Please use the env.EnableFastEvalMode() and c.ExecuteProgram method and will be removed in v0.11.0.

func (*PROTORPC_KclvmServiceClient) AsyncExecProgram

func (c *PROTORPC_KclvmServiceClient) AsyncExecProgram(in *ExecProgram_Args, out *ExecProgram_Result, done chan *rpc.Call) *rpc.Call

func (*PROTORPC_KclvmServiceClient) AsyncFormatCode

func (c *PROTORPC_KclvmServiceClient) AsyncFormatCode(in *FormatCode_Args, out *FormatCode_Result, done chan *rpc.Call) *rpc.Call

func (*PROTORPC_KclvmServiceClient) AsyncFormatPath

func (c *PROTORPC_KclvmServiceClient) AsyncFormatPath(in *FormatPath_Args, out *FormatPath_Result, done chan *rpc.Call) *rpc.Call

func (*PROTORPC_KclvmServiceClient) AsyncGetSchemaTypeMapping

func (c *PROTORPC_KclvmServiceClient) AsyncGetSchemaTypeMapping(in *GetSchemaTypeMapping_Args, out *GetSchemaTypeMapping_Result, done chan *rpc.Call) *rpc.Call

func (*PROTORPC_KclvmServiceClient) AsyncGetVersion added in v0.9.2

func (c *PROTORPC_KclvmServiceClient) AsyncGetVersion(in *GetVersion_Args, out *GetVersion_Result, done chan *rpc.Call) *rpc.Call

func (*PROTORPC_KclvmServiceClient) AsyncLintPath

func (c *PROTORPC_KclvmServiceClient) AsyncLintPath(in *LintPath_Args, out *LintPath_Result, done chan *rpc.Call) *rpc.Call

func (*PROTORPC_KclvmServiceClient) AsyncListDepFiles

func (c *PROTORPC_KclvmServiceClient) AsyncListDepFiles(in *ListDepFiles_Args, out *ListDepFiles_Result, done chan *rpc.Call) *rpc.Call

func (*PROTORPC_KclvmServiceClient) AsyncListOptions added in v0.8.1

func (c *PROTORPC_KclvmServiceClient) AsyncListOptions(in *ParseProgram_Args, out *ListOptions_Result, done chan *rpc.Call) *rpc.Call

func (*PROTORPC_KclvmServiceClient) AsyncListVariables added in v0.8.4

func (c *PROTORPC_KclvmServiceClient) AsyncListVariables(in *ListVariables_Args, out *ListVariables_Result, done chan *rpc.Call) *rpc.Call

func (*PROTORPC_KclvmServiceClient) AsyncLoadPackage added in v0.7.5

func (c *PROTORPC_KclvmServiceClient) AsyncLoadPackage(in *LoadPackage_Args, out *LoadPackage_Result, done chan *rpc.Call) *rpc.Call

func (*PROTORPC_KclvmServiceClient) AsyncLoadSettingsFiles

func (c *PROTORPC_KclvmServiceClient) AsyncLoadSettingsFiles(in *LoadSettingsFiles_Args, out *LoadSettingsFiles_Result, done chan *rpc.Call) *rpc.Call

func (*PROTORPC_KclvmServiceClient) AsyncOverrideFile

func (c *PROTORPC_KclvmServiceClient) AsyncOverrideFile(in *OverrideFile_Args, out *OverrideFile_Result, done chan *rpc.Call) *rpc.Call

func (*PROTORPC_KclvmServiceClient) AsyncParseFile added in v0.7.3

func (c *PROTORPC_KclvmServiceClient) AsyncParseFile(in *ParseFile_Args, out *ParseFile_Result, done chan *rpc.Call) *rpc.Call

func (*PROTORPC_KclvmServiceClient) AsyncParseProgram added in v0.7.3

func (c *PROTORPC_KclvmServiceClient) AsyncParseProgram(in *ParseProgram_Args, out *ParseProgram_Result, done chan *rpc.Call) *rpc.Call

func (*PROTORPC_KclvmServiceClient) AsyncPing

func (c *PROTORPC_KclvmServiceClient) AsyncPing(in *Ping_Args, out *Ping_Result, done chan *rpc.Call) *rpc.Call

func (*PROTORPC_KclvmServiceClient) AsyncRename added in v0.7.0

func (c *PROTORPC_KclvmServiceClient) AsyncRename(in *Rename_Args, out *Rename_Result, done chan *rpc.Call) *rpc.Call

func (*PROTORPC_KclvmServiceClient) AsyncRenameCode added in v0.7.0

func (c *PROTORPC_KclvmServiceClient) AsyncRenameCode(in *RenameCode_Args, out *RenameCode_Result, done chan *rpc.Call) *rpc.Call

func (*PROTORPC_KclvmServiceClient) AsyncTest added in v0.7.0

func (c *PROTORPC_KclvmServiceClient) AsyncTest(in *Test_Args, out *Test_Result, done chan *rpc.Call) *rpc.Call

func (*PROTORPC_KclvmServiceClient) AsyncUpdateDependencies added in v0.9.0

func (c *PROTORPC_KclvmServiceClient) AsyncUpdateDependencies(in *UpdateDependencies_Args, out *UpdateDependencies_Result, done chan *rpc.Call) *rpc.Call

func (*PROTORPC_KclvmServiceClient) AsyncValidateCode

func (c *PROTORPC_KclvmServiceClient) AsyncValidateCode(in *ValidateCode_Args, out *ValidateCode_Result, done chan *rpc.Call) *rpc.Call

func (*PROTORPC_KclvmServiceClient) BuildProgram added in v0.8.0

Depreciated: Please use the env.EnableFastEvalMode() and c.ExecuteProgram method and will be removed in v0.11.0.

func (*PROTORPC_KclvmServiceClient) ExecArtifact added in v0.8.0

func (c *PROTORPC_KclvmServiceClient) ExecArtifact(in *ExecArtifact_Args) (out *ExecProgram_Result, err error)

Depreciated: Please use the env.EnableFastEvalMode() and c.ExecuteProgram method and will be removed in v0.11.0.

func (*PROTORPC_KclvmServiceClient) ExecProgram

func (c *PROTORPC_KclvmServiceClient) ExecProgram(in *ExecProgram_Args) (out *ExecProgram_Result, err error)

func (*PROTORPC_KclvmServiceClient) FormatCode

func (c *PROTORPC_KclvmServiceClient) FormatCode(in *FormatCode_Args) (out *FormatCode_Result, err error)

func (*PROTORPC_KclvmServiceClient) FormatPath

func (c *PROTORPC_KclvmServiceClient) FormatPath(in *FormatPath_Args) (out *FormatPath_Result, err error)

func (*PROTORPC_KclvmServiceClient) GetSchemaTypeMapping

func (*PROTORPC_KclvmServiceClient) GetVersion added in v0.9.2

func (c *PROTORPC_KclvmServiceClient) GetVersion(in *GetVersion_Args) (out *GetVersion_Result, err error)

func (*PROTORPC_KclvmServiceClient) LintPath

func (c *PROTORPC_KclvmServiceClient) LintPath(in *LintPath_Args) (out *LintPath_Result, err error)

func (*PROTORPC_KclvmServiceClient) ListDepFiles

func (*PROTORPC_KclvmServiceClient) ListOptions added in v0.8.1

func (*PROTORPC_KclvmServiceClient) ListVariables added in v0.8.4

func (*PROTORPC_KclvmServiceClient) LoadPackage added in v0.7.5

func (c *PROTORPC_KclvmServiceClient) LoadPackage(in *LoadPackage_Args) (out *LoadPackage_Result, err error)

func (*PROTORPC_KclvmServiceClient) LoadSettingsFiles

func (*PROTORPC_KclvmServiceClient) OverrideFile

func (*PROTORPC_KclvmServiceClient) ParseFile added in v0.7.3

func (c *PROTORPC_KclvmServiceClient) ParseFile(in *ParseFile_Args) (out *ParseFile_Result, err error)

func (*PROTORPC_KclvmServiceClient) ParseProgram added in v0.7.3

func (*PROTORPC_KclvmServiceClient) Ping

func (c *PROTORPC_KclvmServiceClient) Ping(in *Ping_Args) (out *Ping_Result, err error)

func (*PROTORPC_KclvmServiceClient) Rename added in v0.7.0

func (c *PROTORPC_KclvmServiceClient) Rename(in *Rename_Args) (out *Rename_Result, err error)

func (*PROTORPC_KclvmServiceClient) RenameCode added in v0.7.0

func (c *PROTORPC_KclvmServiceClient) RenameCode(in *RenameCode_Args) (out *RenameCode_Result, err error)

func (*PROTORPC_KclvmServiceClient) Test added in v0.7.0

func (c *PROTORPC_KclvmServiceClient) Test(in *Test_Args) (out *Test_Result, err error)

func (*PROTORPC_KclvmServiceClient) UpdateDependencies added in v0.9.0

func (*PROTORPC_KclvmServiceClient) ValidateCode

type ParseFile_Args added in v0.7.3

type ParseFile_Args = api.ParseFile_Args

Message for parse file request arguments.

type ParseFile_Result added in v0.7.3

type ParseFile_Result = api.ParseFile_Result

Message for parse file response.

type ParseProgram_Args added in v0.7.3

type ParseProgram_Args = api.ParseProgram_Args

Message for parse program request arguments.

type ParseProgram_Result added in v0.7.3

type ParseProgram_Result = api.ParseProgram_Result

Message for parse program response.

type Ping_Args

type Ping_Args = api.Ping_Args

Message for ping request arguments.

type Ping_Result

type Ping_Result = api.Ping_Result

Message for ping response.

type Position

type Position = api.Position

Message representing a position in the source code.

type RenameCode_Args added in v0.7.0

type RenameCode_Args = api.RenameCode_Args

Message for rename code request arguments.

type RenameCode_Result added in v0.7.0

type RenameCode_Result = api.RenameCode_Result

Message for rename code response.

type Rename_Args added in v0.7.0

type Rename_Args = api.Rename_Args

Message for rename request arguments.

type Rename_Result added in v0.7.0

type Rename_Result = api.Rename_Result

Message for rename response.

type Scope added in v0.7.5

type Scope = api.Scope

Message representing a scope in KCL.

type ScopeIndex added in v0.7.5

type ScopeIndex = api.ScopeIndex

Message representing a scope index.

type Symbol added in v0.7.5

type Symbol = api.Symbol

Message representing a symbol in KCL.

type SymbolIndex added in v0.7.5

type SymbolIndex = api.SymbolIndex

Message representing a symbol index.

type TestCaseInfo added in v0.7.0

type TestCaseInfo = api.TestCaseInfo

Message representing information about a single test case.

type Test_Args added in v0.7.0

type Test_Args = api.Test_Args

Message for test request arguments.

type Test_Result added in v0.7.0

type Test_Result = api.Test_Result

Message for test response.

type UnimplementedKclvmServiceServer

type UnimplementedKclvmServiceServer struct {
}

UnimplementedKclvmServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedKclvmServiceServer) BuildProgram added in v0.8.0

Depreciated: Please use the env.EnableFastEvalMode() and c.ExecuteProgram method and will be removed in v0.11.0.

func (*UnimplementedKclvmServiceServer) ExecArtifact added in v0.8.0

Depreciated: Please use the env.EnableFastEvalMode() and c.ExecuteProgram method and will be removed in v0.11.0.

func (*UnimplementedKclvmServiceServer) ExecProgram

func (*UnimplementedKclvmServiceServer) FormatCode

func (*UnimplementedKclvmServiceServer) FormatPath

func (*UnimplementedKclvmServiceServer) GetSchemaTypeMapping

func (*UnimplementedKclvmServiceServer) GetVersion added in v0.9.2

func (*UnimplementedKclvmServiceServer) LintPath

func (*UnimplementedKclvmServiceServer) ListDepFiles

func (*UnimplementedKclvmServiceServer) ListOptions added in v0.8.1

func (*UnimplementedKclvmServiceServer) ListVariables added in v0.8.4

func (*UnimplementedKclvmServiceServer) LoadPackage added in v0.7.5

func (*UnimplementedKclvmServiceServer) LoadSettingsFiles

func (*UnimplementedKclvmServiceServer) OverrideFile

func (*UnimplementedKclvmServiceServer) ParseFile added in v0.7.3

func (*UnimplementedKclvmServiceServer) ParseProgram added in v0.7.3

func (*UnimplementedKclvmServiceServer) Ping

func (*UnimplementedKclvmServiceServer) Rename added in v0.7.0

func (*UnimplementedKclvmServiceServer) RenameCode added in v0.7.0

func (*UnimplementedKclvmServiceServer) Test added in v0.7.0

func (*UnimplementedKclvmServiceServer) UpdateDependencies added in v0.9.0

func (*UnimplementedKclvmServiceServer) ValidateCode

type UpdateDependencies_Args added in v0.9.0

type UpdateDependencies_Args = api.UpdateDependencies_Args

Message for update dependencies request arguments.

type UpdateDependencies_Result added in v0.9.0

type UpdateDependencies_Result = api.UpdateDependencies_Result

Message for update dependencies response.

type ValidateCode_Args

type ValidateCode_Args = api.ValidateCode_Args

Message for validate code request arguments.

type ValidateCode_Result

type ValidateCode_Result = api.ValidateCode_Result

Message for validate code response.

type Variable added in v0.8.4

type Variable = api.Variable

Message representing a variable.

type VariableList added in v0.9.0

type VariableList = api.VariableList

Message representing a list of variables.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL