goplay

Documentation

Index

• Constants
• Variables
• func IsCompileError(err error) bool
• func ValidateContentLength(itemLen int) error
• type Client
  • func NewClient(baseUrl, userAgent string, timeout time.Duration) *Client
  • func NewDefaultClient() *Client
  • func (c *Client) Compile(ctx context.Context, src []byte) (*CompileResponse, error)
  • func (c *Client) GetSnippet(ctx context.Context, snippetID string) (*Snippet, error)
  • func (c *Client) GoImports(ctx context.Context, src []byte) (*FmtResponse, error)
  • func (c *Client) Share(ctx context.Context, src io.Reader) (string, error)
• type CompileEvent
• type CompileFailedError
  • func (c CompileFailedError) Error() string
• type CompileResponse
  • func (cr CompileResponse) GetBody() string
  • func (cr *CompileResponse) HasError() error
• type FmtResponse
  • func (r *FmtResponse) HasError() error
• type Snippet

Constants

const (
	DefaultUserAgent          = "goplay.tools/1.0 (http://goplay.tools/)"
	DefaultPlaygroundURL      = "https://play.golang.org"
	DefaultGoTipPlaygroundURL = "https://gotipplay.golang.org"
)

Variables

var ErrSnippetNotFound = errors.New("snippet not found")

ErrSnippetNotFound is snippet not found error

var ErrSnippetTooLarge = fmt.Errorf("code snippet too large (max %d bytes)", maxSnippetSize)

ErrSnippetTooLarge is snippet max size limit error

Functions

func IsCompileError

func IsCompileError(err error) bool

IsCompileError checks if error is CompileFailedError

func ValidateContentLength

func ValidateContentLength(itemLen int) error

ValidateContentLength validates snippet size

Types

type Client

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

Client is Go Playground API client

func NewClient

func NewClient(baseUrl, userAgent string, timeout time.Duration) *Client

NewClient returns new Go playground client

func NewDefaultClient

func NewDefaultClient() *Client

NewDefaultClient returns Go Playground client with defaults

func (*Client) Compile

func (c *Client) Compile(ctx context.Context, src []byte) (*CompileResponse, error)

Compile runs code in goplayground and returns response

func (*Client) GetSnippet

func (c *Client) GetSnippet(ctx context.Context, snippetID string) (*Snippet, error)

GetSnippet returns snippet from Go playground

func (*Client) GoImports

func (c *Client) GoImports(ctx context.Context, src []byte) (*FmtResponse, error)

GoImports performs Goimports

func (*Client) Share

func (c *Client) Share(ctx context.Context, src io.Reader) (string, error)

Share shares snippet to go playground

type CompileEvent

type CompileEvent struct {
	Message string
	Kind    string
	Delay   time.Duration
}

CompileEvent represents individual event record in CompileResponse

type CompileFailedError

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

CompileFailedError is build error

func (CompileFailedError) Error

func (c CompileFailedError) Error() string

Error implements error

type CompileResponse

type CompileResponse struct {
	Body   *string
	Events []*CompileEvent
	Errors string
}

CompileResponse is the response returned from upstream play.golang.org/compile request

func (CompileResponse) GetBody

func (cr CompileResponse) GetBody() string

GetBody returns response body

func (*CompileResponse) HasError

func (cr *CompileResponse) HasError() error

HasError returns error if any occurred

type FmtResponse

type FmtResponse struct {
	Body  string
	Error string
}

FmtResponse is the response returned from upstream play.golang.org/fmt request

func (*FmtResponse) HasError

func (r *FmtResponse) HasError() error

HasError returns error if any occurred

type Snippet

type Snippet struct {
	FileName string
	Contents string
}

Snippet represents shared snippet