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 BytesService
  • func (b *BytesService) Download(ctx context.Context, a swarm.Address) (resp io.ReadCloser, err error)
  • func (b *BytesService) Upload(ctx context.Context, data io.Reader) (resp BytesUploadResponse, err error)
• type BytesUploadResponse
• type ChunksService
  • func (c *ChunksService) Download(ctx context.Context, a swarm.Address) (resp io.ReadCloser, err error)
  • func (c *ChunksService) Upload(ctx context.Context, a swarm.Address, data io.Reader) (resp ChunksUploadResponse, err error)
• type ChunksUploadResponse
• type Client
  • func NewClient(baseURL *url.URL, o *ClientOptions) (c *Client)
• type ClientOptions
• type FilesService
  • func (f *FilesService) Download(ctx context.Context, a swarm.Address) (resp io.ReadCloser, err error)
  • func (f *FilesService) Upload(ctx context.Context, name string, data io.Reader, size int64) (resp FilesUploadResponse, err error)
• type FilesUploadResponse

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")
	ErrServiceUnavailable  = errors.New("service unavailable")
)

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 BytesService

type BytesService service

BytesService represents Bee's Bytes service

func (*BytesService) Download

func (b *BytesService) Download(ctx context.Context, a swarm.Address) (resp io.ReadCloser, err error)

Download downloads data from the node

func (*BytesService) Upload

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

Upload uploads bytes to the node

type BytesUploadResponse

type BytesUploadResponse struct {
	Reference swarm.Address `json:"reference"`
}

BytesUploadResponse represents Upload's response

type ChunksService

type ChunksService service

ChunksService represents Bee's Chunks service

func (*ChunksService) Download

func (c *ChunksService) Download(ctx context.Context, a swarm.Address) (resp io.ReadCloser, err error)

Download downloads data from the node

func (*ChunksService) Upload

func (c *ChunksService) Upload(ctx context.Context, a swarm.Address, data io.Reader) (resp ChunksUploadResponse, err error)

Upload uploads chunks to the node

type ChunksUploadResponse

type ChunksUploadResponse struct {
	Message string `json:"message,omitempty"`
	Code    int    `json:"code,omitempty"`
}

ChunksUploadResponse represents Upload's response

type Client

type Client struct {

	// Services that API provides.
	Bytes  *BytesService
	Chunks *ChunksService
	Files  *FilesService
	// 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 FilesService

type FilesService service

FilesService represents Bee's Files service

func (*FilesService) Download

func (f *FilesService) Download(ctx context.Context, a swarm.Address) (resp io.ReadCloser, err error)

Download downloads data from the node

func (*FilesService) Upload

func (f *FilesService) Upload(ctx context.Context, name string, data io.Reader, size int64) (resp FilesUploadResponse, err error)

Upload uploads files to the node

type FilesUploadResponse

type FilesUploadResponse struct {
	Reference swarm.Address `json:"reference"`
}

FilesUploadResponse represents Upload's response