api

Documentation

Index

• Variables
• func Bool(v bool) (p *bool)
• type BadRequestError
  • func NewBadRequestError(errors ...string) (err *BadRequestError)
  • func (e *BadRequestError) Error() (s string)
  • func (e *BadRequestError) Errors() (errs []string)
• type BzzService
  • func (b *BzzService) Upload(ctx context.Context, data io.Reader) (resp BzzUploadResponse, err error)
• type BzzUploadResponse
• type Client
  • func NewClient(baseURL *url.URL, o *ClientOptions) (c *Client)
• type ClientOptions
• type PingPongService
  • func (p *PingPongService) Ping(ctx context.Context, overylay swarm.Address) (resp Pong, err error)
• type Pong

Variables

var (
	ErrUnauthorized        = errors.New("unauthorized")
	ErrForbidden           = errors.New("forbidden")
	ErrNotFound            = errors.New("not found")
	ErrMethodNotAllowed    = errors.New("method not allowed")
	ErrTooManyRequests     = errors.New("too many requests")
	ErrInternalServerError = errors.New("internal server error")
	ErrMaintenance         = errors.New("maintenance")
)

Errors that are returned by the API.

Functions

func Bool

func Bool(v bool) (p *bool)

Bool is a helper routine that allocates a new bool value to store v and returns a pointer to it.

Types

type BadRequestError

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

BadRequestError holds list of errors from http response that represent invalid data submitted by the user.

func NewBadRequestError

func NewBadRequestError(errors ...string) (err *BadRequestError)

NewBadRequestError constructs a new BadRequestError with provided errors.

func (*BadRequestError) Error

func (e *BadRequestError) Error() (s string)

func (*BadRequestError) Errors

func (e *BadRequestError) Errors() (errs []string)

Errors returns a list of error messages.

type BzzService

type BzzService service

BzzService ...

func (*BzzService) Upload

func (b *BzzService) Upload(ctx context.Context, data io.Reader) (resp BzzUploadResponse, err error)

Upload ...

type BzzUploadResponse

type BzzUploadResponse struct {
	Hash swarm.Address `json:"hash"`
}

BzzUploadResponse ...

type Client

type Client struct {

	// Services that API provides.
	Bzz      *BzzService
	PingPong *PingPongService
	// contains filtered or unexported fields
}

Client manages communication with the Bee API.

func NewClient

func NewClient(baseURL *url.URL, o *ClientOptions) (c *Client)

NewClient constructs a new Client.

type ClientOptions

type ClientOptions struct {
	HTTPClient *http.Client
}

ClientOptions holds optional parameters for the Client.

type PingPongService

type PingPongService service

PingPongService ...

func (*PingPongService) Ping

func (p *PingPongService) Ping(ctx context.Context, overylay swarm.Address) (resp Pong, err error)

Ping ...

type Pong

type Pong struct {
	RTT string `json:"rtt"`
}

Pong ...