scalefile

Documentation

Overview

Package scalefile implements the ScaleFile type, as well as any helper functions for interacting with ScaleFile types

Index

• Constants
• Variables
• type ExtensionSchema
• type Schema
  • func ReadSchema(path string) (*Schema, error)
  • func (s *Schema) Decode(data []byte) error
  • func (s *Schema) Encode() ([]byte, error)
  • func (s *Schema) Validate() error
• type SignatureSchema

Constants

const (
	V1AlphaVersion = "v1alpha"
)

Variables

var (
	ErrInvalidName = errors.New("invalid name")
	ErrInvalidTag  = errors.New("invalid tag")
)

Types

type ExtensionSchema

type ExtensionSchema struct {
	Organization string `hcl:"organization,attr"`
	Name         string `hcl:"name,attr"`
	Tag          string `hcl:"tag,attr"`
}

type Schema

type Schema struct {
	Version     string            `hcl:"version,attr"`
	Name        string            `hcl:"name,attr"`
	Tag         string            `hcl:"tag,attr"`
	Language    string            `hcl:"language,attr"`
	Signature   SignatureSchema   `hcl:"signature,block"`
	Stateless   bool              `hcl:"stateless,optional"`
	Function    string            `hcl:"function,attr"`
	Initialize  string            `hcl:"initialize,attr"`
	Description string            `hcl:"description,optional"`
	Extensions  []ExtensionSchema `hcl:"extension,block"`
}

func ReadSchema

func ReadSchema(path string) (*Schema, error)

func (*Schema) Decode

func (s *Schema) Decode(data []byte) error

func (*Schema) Encode

func (s *Schema) Encode() ([]byte, error)

func (*Schema) Validate

func (s *Schema) Validate() error

type SignatureSchema

type SignatureSchema struct {
	Organization string `hcl:"organization,attr"`
	Name         string `hcl:"name,attr"`
	Tag          string `hcl:"tag,attr"`
}