goplay

Documentation

Index

• Constants
• Variables
• func IsCompileError(err error) bool
• func ValidateBackend(backend Backend) bool
• type Backend
• type Client
  • func NewClient(baseUrl, userAgent string, timeout time.Duration) *Client
  • func NewDefaultClient() *Client
  • func (c *Client) Compile(ctx context.Context, req CompileRequest, backend string) (*CompileResponse, error)
  • func (c *Client) GetSnippet(ctx context.Context, snippetID string) (*Snippet, error)
  • func (c *Client) GoImports(ctx context.Context, src []byte, backend Backend) (*FmtResponse, error)
  • func (c *Client) Share(ctx context.Context, src io.Reader) (string, error)
• type CompileEvent
• type CompileFailedError
  • func (c CompileFailedError) Error() string
• type CompileRequest
  • func (r CompileRequest) URLValues() url.Values
• type CompileResponse
  • func (cr CompileResponse) GetBody() string
  • func (cr *CompileResponse) HasError() error
• type FmtResponse
  • func (r *FmtResponse) HasError() error
• type HTTPError
  • func IsHTTPError(err error) (*HTTPError, bool)
  • func NewHTTPError(rsp *http.Response) *HTTPError
  • func (err HTTPError) Error() string
• type Snippet

Constants

const (
	DefaultUserAgent     = "goplay.tools/1.0 (http://goplay.tools/)"
	DefaultPlaygroundURL = "https://go.dev/_"

	// MaxSnippetSize value taken from
	// https://github.com/golang/playground/blob/master/app/goplay/share.go
	MaxSnippetSize = 64 * 1024
)

const (
	BackendGoCurrent = ""
	BackendGoPrev    = "goprev"
	BackendGoTip     = "gotip"
)

const DefaultVersion = 2

Variables

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

ErrSnippetNotFound is snippet not found error

Functions

func IsCompileError

func IsCompileError(err error) bool

IsCompileError checks if error is CompileFailedError

func ValidateBackend

func ValidateBackend(backend Backend) bool

ValidateBackend validates Go Playground backend name.

Types

type Backend

type Backend = string

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, req CompileRequest, backend string) (*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, backend Backend) (*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 CompileRequest

type CompileRequest struct {
	Version int
	WithVet bool
	Body    []byte
}

func (CompileRequest) URLValues

func (r CompileRequest) URLValues() url.Values

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 HTTPError

type HTTPError struct {
	StatusCode int
	Status     string
}

func IsHTTPError

func IsHTTPError(err error) (*HTTPError, bool)

IsHTTPError checks if passed error is HTTPError.

func NewHTTPError

func NewHTTPError(rsp *http.Response) *HTTPError

func (HTTPError) Error

func (err HTTPError) Error() string

type Snippet

type Snippet struct {
	FileName string
	Contents string
}

Snippet represents shared snippet