webfolder

Documentation

Index

• type Option
  • func WithBaseURL(url string) Option
  • func WithHeimdallClient(client heimdall.Client) Option
• type Storage
  • func NewStorage(opts ...Option) *Storage
  • func (s *Storage) Get(ctx context.Context, path string) storage.IResponse
  • func (s *Storage) GetPartially(ctx context.Context, path string, _ *storage.GetPartiallyRequestOptions) storage.IResponse

Types

type Option

type Option func(s *Storage)

Option represents the Cloudfront storage options

func WithBaseURL

func WithBaseURL(url string) Option

WithBaseURL sets the baseURL

func WithHeimdallClient

func WithHeimdallClient(client heimdall.Client) Option

WithHeimdallClient sets the client

type Storage

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

Storage holds the fields used by webfolder storage implementation

func NewStorage

func NewStorage(opts ...Option) *Storage

NewStorage returns a new webfolder.Storage instance

func (*Storage) Get

func (s *Storage) Get(ctx context.Context, path string) storage.IResponse

Get takes in the Context and path as an argument and returns an IResponse interface implementation. This method figures out how to get the data from the WebFolder storage backend.

func (*Storage) GetPartially

func (s *Storage) GetPartially(ctx context.Context, path string, _ *storage.GetPartiallyRequestOptions) storage.IResponse

GetPartially takes in the Context, path and opt (which ignored) as an argument and returns an IResponse interface implementation. This method is an alias of `Get` method