client

Documentation

Overview

Package client is a client for the Scrap Exchange REST API.

Index

• type Client
  • func New(host string) (*Client, error)
  • func (c *Client) CreateScrap(ctx context.Context, body scrap.ScrapBody) (scrap.ScrapID, error)
  • func (c *Client) DeleteName(ctx context.Context, t scrap.Type, name string) error
  • func (c *Client) DeleteScrap(ctx context.Context, t scrap.Type, hashOrName string) error
  • func (c *Client) Expand(ctx context.Context, t scrap.Type, hashOrName string, lang scrap.Lang, ...) error
  • func (c *Client) GetName(ctx context.Context, t scrap.Type, name string) (scrap.Name, error)
  • func (c *Client) ListNames(ctx context.Context, t scrap.Type) ([]string, error)
  • func (c *Client) LoadScrap(ctx context.Context, t scrap.Type, hashOrName string) (scrap.ScrapBody, error)
  • func (c *Client) PutName(ctx context.Context, t scrap.Type, name string, nameBody scrap.Name) error

Types

type Client

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

Client implements api.ScrapExchange using the HTTP REST API talking to a server.

func New

func New(host string) (*Client, error)

New returns a new instance of Client.

The value of the host should be the base scheme, host, and port that all requests should go to, e.g. "http://scrapexchange:9000".

func (*Client) CreateScrap

func (c *Client) CreateScrap(ctx context.Context, body scrap.ScrapBody) (scrap.ScrapID, error)

CreateScrap implements scrap.ScrapExchange.

func (*Client) DeleteName

func (c *Client) DeleteName(ctx context.Context, t scrap.Type, name string) error

DeleteName implements scrap.ScrapExchange.

func (*Client) DeleteScrap

func (c *Client) DeleteScrap(ctx context.Context, t scrap.Type, hashOrName string) error

DeleteScrap implements scrap.ScrapExchange.

func (*Client) Expand

func (c *Client) Expand(ctx context.Context, t scrap.Type, hashOrName string, lang scrap.Lang, w io.Writer) error

Expand implements scrap.ScrapExchange.

func (*Client) GetName

func (c *Client) GetName(ctx context.Context, t scrap.Type, name string) (scrap.Name, error)

GetName implements scrap.ScrapExchange.

func (*Client) ListNames

func (c *Client) ListNames(ctx context.Context, t scrap.Type) ([]string, error)

ListNames implements scrap.ScrapExchange.

func (*Client) LoadScrap

func (c *Client) LoadScrap(ctx context.Context, t scrap.Type, hashOrName string) (scrap.ScrapBody, error)

LoadScrap implements scrap.ScrapExchange.

func (*Client) PutName

func (c *Client) PutName(ctx context.Context, t scrap.Type, name string, nameBody scrap.Name) error

PutName implements scrap.ScrapExchange.