cs

Documentation

Overview

Package cs provides a simple API for the Google Cloud Storage service.

Index

• Variables
• type Attributes
• type Client
  • func New(ctx context.Context, bucket string) (*Client, error)
  • func NewFromClient(bucket string, client *storage.Client) *Client
  • func (c *Client) DeleteObjects(ctx context.Context, q *Query) (int, error)
  • func (c *Client) GetObjectWithData(ctx context.Context, name string) (*ObjectWithData, error)
  • func (c *Client) GetObjects(ctx context.Context, q *Query) ([]*Object, error)
  • func (c *Client) WriteObject(ctx context.Context, name string, data io.ReadCloser, attrs *Attributes) error
• type Object
• type ObjectWithData
• type Operations
• type Query

Variables

var (
	ErrObjectNotExist = errors.New("object does not exist")
	ErrBucketNotExist = errors.New("bucket does not exist")
)

Types

type Attributes

type Attributes struct {
	ContentType     string
	ContentEncoding string
	Size            int64
	SizeStr         string
}

type Client

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

func New

func New(ctx context.Context, bucket string) (*Client, error)

func NewFromClient

func NewFromClient(bucket string, client *storage.Client) *Client

func (*Client) DeleteObjects

func (c *Client) DeleteObjects(ctx context.Context, q *Query) (int, error)

func (*Client) GetObjectWithData

func (c *Client) GetObjectWithData(ctx context.Context, name string) (*ObjectWithData, error)

func (*Client) GetObjects

func (c *Client) GetObjects(ctx context.Context, q *Query) ([]*Object, error)

func (*Client) WriteObject

func (c *Client) WriteObject(ctx context.Context, name string, data io.ReadCloser, attrs *Attributes) error

type Object

type Object struct {
	Name   string
	Bucket string
	Attrs  Attributes
}

type ObjectWithData

type ObjectWithData struct {
	*Object
	Data []byte
}

type Operations

type Operations interface {
	DeleteObjects(ctx context.Context, q *Query) (int, error)
	WriteObject(ctx context.Context, name string, data io.ReadCloser, attrs *Attributes) error
	GetObjects(ctx context.Context, q *Query) ([]*Object, error)
	GetObjectWithData(ctx context.Context, name string) (*ObjectWithData, error)
}

type Query

type Query struct {
	Prefix string
}