client

Documentation

Overview

Package client provides tools to interact with a varda server.

Index

• type Client
  • func New(cfg config.Client, opts ...Option) (*Client, error)
  • func (c *Client) Close() error
  • func (c *Client) Do(r *http.Request) (*http.Response, error)
  • func (c *Client) Endpoint(name string) string
  • func (c *Client) Fetch(ctx context.Context, v varda.Ref) (io.ReadCloser, error)
  • func (c *Client) FindRef(ctx context.Context, sha string) (varda.Ref, error)
  • func (c *Client) IterRef(ctx context.Context, f func(v varda.Ref) error) error
  • func (c *Client) Login(ctx context.Context) error
  • func (c *Client) NumRef(ctx context.Context) (int64, error)
  • func (c *Client) Query(ctx context.Context, qry search.Query) (*search.Result, error)
  • func (c *Client) Search(ctx context.Context, qry search.Query, f func(ref varda.Ref) error) error
  • func (c *Client) Upload(ctx context.Context, f varda.File) (varda.Ref, error)
  • func (c *Client) UploadRefs(ctx context.Context, vs []varda.File) ([]varda.Ref, error)
• type Option
  • func WithAuth(a auth.Mode) Option
  • func WithHTTP(cli *http.Client) Option
• type UploadError
  • func (ue UploadError) Error() string
  • func (ue UploadError) Unwrap() error

Types

type Client

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

Client provides access to a Varda server. After use, a Client should be closed via its Close method.

func New

func New(cfg config.Client, opts ...Option) (*Client, error)

New creates a new client with the provided client configuration.

func (*Client) Close

func (c *Client) Close() error

func (*Client) Do

func (c *Client) Do(r *http.Request) (*http.Response, error)

func (*Client) Endpoint

func (c *Client) Endpoint(name string) string

func (*Client) Fetch

func (c *Client) Fetch(ctx context.Context, v varda.Ref) (io.ReadCloser, error)

func (*Client) FindRef

func (c *Client) FindRef(ctx context.Context, sha string) (varda.Ref, error)

func (*Client) IterRef

func (c *Client) IterRef(ctx context.Context, f func(v varda.Ref) error) error

func (*Client) Login

func (c *Client) Login(ctx context.Context) error

func (*Client) NumRef

func (c *Client) NumRef(ctx context.Context) (int64, error)

func (*Client) Query

func (c *Client) Query(ctx context.Context, qry search.Query) (*search.Result, error)

func (*Client) Search

func (c *Client) Search(ctx context.Context, qry search.Query, f func(ref varda.Ref) error) error

func (*Client) Upload

func (c *Client) Upload(ctx context.Context, f varda.File) (varda.Ref, error)

func (*Client) UploadRefs

func (c *Client) UploadRefs(ctx context.Context, vs []varda.File) ([]varda.Ref, error)

type Option

type Option func(c *Client)

Option provides configuration of a varda client.

func WithAuth

func WithAuth(a auth.Mode) Option

WithAuth configures a varda client to use the provided authentication mechanism.

func WithHTTP

func WithHTTP(cli *http.Client) Option

WithHTTP configures a varda client to use the provided HTTP client.

type UploadError

type UploadError struct {
	File varda.File
	Err  error
}

UploadError describes which varda resources failed to upload.

func (UploadError) Error

func (ue UploadError) Error() string

func (UploadError) Unwrap

func (ue UploadError) Unwrap() error