msgapi

Documentation

Overview

===----------------------------------------------------------------------===// Copyright © 2024 Apple Inc. and the Pkl project authors. All rights reserved.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. ===----------------------------------------------------------------------===//

===----------------------------------------------------------------------===// Copyright © 2024 Apple Inc. and the Pkl project authors. All rights reserved.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. ===----------------------------------------------------------------------===//

===----------------------------------------------------------------------===// Copyright © 2024 Apple Inc. and the Pkl project authors. All rights reserved.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. ===----------------------------------------------------------------------===//

Index

• type Checksums
• type CloseEvaluator
  • func (msg *CloseEvaluator) ToMsgPack() ([]byte, error)
• type CreateEvaluator
  • func (msg *CreateEvaluator) ToMsgPack() ([]byte, error)
• type CreateEvaluatorResponse
• type Evaluate
  • func (msg *Evaluate) ToMsgPack() ([]byte, error)
• type EvaluateResponse
• type IncomingMessage
  • func Decode(decoder *msgpack.Decoder) (IncomingMessage, error)
• type ListModules
• type ListModulesResponse
  • func (msg ListModulesResponse) ToMsgPack() ([]byte, error)
• type ListResources
• type ListResourcesResponse
  • func (msg ListResourcesResponse) ToMsgPack() ([]byte, error)
• type Log
• type ModuleReader
• type OutgoingMessage
• type PathElement
• type ProjectOrDependency
• type ReadModule
• type ReadModuleResponse
  • func (msg *ReadModuleResponse) ToMsgPack() ([]byte, error)
• type ReadResource
• type ReadResourceResponse
  • func (msg *ReadResourceResponse) ToMsgPack() ([]byte, error)
• type ResourceReader

Types

type Checksums

type Checksums struct {
	Sha256 string `msgpack:"checksums"`
}

type CloseEvaluator

type CloseEvaluator struct {
	EvaluatorId int64 `msgpack:"evaluatorId,omitempty"`
}

func (*CloseEvaluator) ToMsgPack

func (msg *CloseEvaluator) ToMsgPack() ([]byte, error)

type CreateEvaluator

type CreateEvaluator struct {
	RequestId        int64                `msgpack:"requestId"`
	ResourceReaders  []*ResourceReader    `msgpack:"clientResourceReaders,omitempty"`
	ModuleReaders    []*ModuleReader      `msgpack:"clientModuleReaders,omitempty"`
	ModulePaths      []string             `msgpack:"modulePaths,omitempty"`
	Env              map[string]string    `msgpack:"env,omitempty"`
	Properties       map[string]string    `msgpack:"properties,omitempty"`
	OutputFormat     string               `msgpack:"outputFormat,omitempty"`
	AllowedModules   []string             `msgpack:"allowedModules,omitempty"`
	AllowedResources []string             `msgpack:"allowedResources,omitempty"`
	RootDir          string               `msgpack:"rootDir,omitempty"`
	CacheDir         string               `msgpack:"cacheDir,omitempty"`
	Project          *ProjectOrDependency `msgpack:"project,omitempty"`
	// Intentionally not used right now. Go has `context.WithTimeout` which is a more canonical way to handle timeouts.
	TimeoutSeconds int64 `msgpack:"timeoutSeconds,omitempty"`
}

func (*CreateEvaluator) ToMsgPack

func (msg *CreateEvaluator) ToMsgPack() ([]byte, error)

type CreateEvaluatorResponse

type CreateEvaluatorResponse struct {
	RequestId   int64  `msgpack:"requestId"`
	EvaluatorId int64  `msgpack:"evaluatorId"`
	Error       string `msgpack:"error"`
	// contains filtered or unexported fields
}

type Evaluate

type Evaluate struct {
	RequestId   int64  `msgpack:"requestId"`
	EvaluatorId int64  `msgpack:"evaluatorId"`
	ModuleUri   string `msgpack:"moduleUri"`
	ModuleText  string `msgpack:"moduleText,omitempty"`
	Expr        string `msgpack:"expr,omitempty"`
}

func (*Evaluate) ToMsgPack

func (msg *Evaluate) ToMsgPack() ([]byte, error)

type EvaluateResponse

type EvaluateResponse struct {
	RequestId   int64  `msgpack:"requestId"`
	EvaluatorId int64  `msgpack:"evaluatorId"`
	Result      []byte `msgpack:"result"`
	Error       string `msgpack:"error"`
	// contains filtered or unexported fields
}

type IncomingMessage

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

func Decode

func Decode(decoder *msgpack.Decoder) (IncomingMessage, error)

type ListModules

type ListModules struct {
	RequestId   int64  `msgpack:"requestId"`
	EvaluatorId int64  `msgpack:"evaluatorId"`
	Uri         string `msgpack:"uri"`
	// contains filtered or unexported fields
}

type ListModulesResponse

type ListModulesResponse struct {
	RequestId    int64          `msgpack:"requestId"`
	EvaluatorId  int64          `msgpack:"evaluatorId"`
	PathElements []*PathElement `msgpack:"pathElements,omitempty"`
	Error        string         `msgpack:"error,omitempty"`
}

func (ListModulesResponse) ToMsgPack

func (msg ListModulesResponse) ToMsgPack() ([]byte, error)

type ListResources

type ListResources struct {
	RequestId   int64  `msgpack:"requestId"`
	EvaluatorId int64  `msgpack:"evaluatorId"`
	Uri         string `msgpack:"uri"`
	// contains filtered or unexported fields
}

type ListResourcesResponse

type ListResourcesResponse struct {
	RequestId    int64          `msgpack:"requestId"`
	EvaluatorId  int64          `msgpack:"evaluatorId"`
	PathElements []*PathElement `msgpack:"pathElements,omitempty"`
	Error        string         `msgpack:"error,omitempty"`
}

func (ListResourcesResponse) ToMsgPack

func (msg ListResourcesResponse) ToMsgPack() ([]byte, error)

type Log

type Log struct {
	EvaluatorId int64  `msgpack:"evaluatorId"`
	Level       int    `msgpack:"level"`
	Message     string `msgpack:"message"`
	FrameUri    string `msgpack:"frameUri"`
	// contains filtered or unexported fields
}

type ModuleReader

type ModuleReader struct {
	Scheme              string `msgpack:"scheme"`
	HasHierarchicalUris bool   `msgpack:"hasHierarchicalUris"`
	IsGlobbable         bool   `msgpack:"isGlobbable"`
	IsLocal             bool   `msgpack:"isLocal"`
}

type OutgoingMessage

type OutgoingMessage interface {
	ToMsgPack() ([]byte, error)
}

type PathElement

type PathElement struct {
	Name        string `msgpack:"name"`
	IsDirectory bool   `msgpack:"isDirectory"`
}

type ProjectOrDependency

type ProjectOrDependency struct {
	PackageUri     string                          `msgpack:"packageUri,omitempty"`
	Type           string                          `msgpack:"type"`
	ProjectFileUri string                          `msgpack:"projectFileUri,omitempty"`
	Checksums      *Checksums                      `msgpack:"checksums,omitempty"`
	Dependencies   map[string]*ProjectOrDependency `msgpack:"dependencies,omitempty"`
}

type ReadModule

type ReadModule struct {
	RequestId   int64  `msgpack:"requestId"`
	EvaluatorId int64  `msgpack:"evaluatorId"`
	Uri         string `msgpack:"uri"`
	// contains filtered or unexported fields
}

type ReadModuleResponse

type ReadModuleResponse struct {
	RequestId   int64  `msgpack:"requestId"`
	EvaluatorId int64  `msgpack:"evaluatorId"`
	Contents    string `msgpack:"contents,omitempty"`
	Error       string `msgpack:"error,omitempty"`
}

func (*ReadModuleResponse) ToMsgPack

func (msg *ReadModuleResponse) ToMsgPack() ([]byte, error)

type ReadResource

type ReadResource struct {
	RequestId   int64  `msgpack:"requestId"`
	EvaluatorId int64  `msgpack:"evaluatorId"`
	Uri         string `msgpack:"uri"`
	// contains filtered or unexported fields
}

type ReadResourceResponse

type ReadResourceResponse struct {
	RequestId   int64  `msgpack:"requestId"`
	EvaluatorId int64  `msgpack:"evaluatorId"`
	Contents    []byte `msgpack:"contents,omitempty"`
	Error       string `msgpack:"error,omitempty"`
}

func (*ReadResourceResponse) ToMsgPack

func (msg *ReadResourceResponse) ToMsgPack() ([]byte, error)

type ResourceReader

type ResourceReader struct {
	Scheme              string `msgpack:"scheme"`
	HasHierarchicalUris bool   `msgpack:"hasHierarchicalUris"`
	IsGlobbable         bool   `msgpack:"isGlobbable"`
}