asset

Documentation

Index

• type FileGetter
• type FilePostRequestGenerator
• type FilePutter
• type FileRange
• type FileRangeNotAcceptedError
  • func (e FileRangeNotAcceptedError) Error() string
• type FileRangedGetResult
• type FileRangedGetter
• type PostFileRequest
• type SignatureParser
• type Store
  • func NewCloudStore(appName string, host string, authToken string, publicURLPrefix string, ...) (Store, error)
  • func NewFileStore(dir, prefix, secret string, public bool) Store
  • func NewS3Store(accessKey string, secretKey string, regionName string, bucketName string, ...) (Store, error)
• type URLSigner
• type URLSignerStore

Types

type FileGetter

type FileGetter interface {
	GetFileReader(name string) (io.ReadCloser, error)
}

FileGetter defines the interface of a getter for files

type FilePostRequestGenerator

type FilePostRequestGenerator interface {
	GeneratePostFileRequest(
		name string,
		contentType string,
		length int64,
	) (*PostFileRequest, error)
}

FilePostRequestGenerator defines the interface of a generator for post file request

type FilePutter

type FilePutter interface {
	PutFileReader(
		name string,
		src io.Reader,
		length int64,
		contentType string,
	) error
}

FilePutter defines the interface of a putter for files

type FileRange

type FileRange struct {
	From int64
	To   int64
}

FileRange models a byte range of a file

type FileRangeNotAcceptedError

type FileRangeNotAcceptedError struct {
	Range FileRange
}

FileRangeNotAcceptedError defines the range not accepted error

func (FileRangeNotAcceptedError) Error

func (e FileRangeNotAcceptedError) Error() string

type FileRangedGetResult

type FileRangedGetResult struct {
	ReadCloser    io.ReadCloser
	AcceptedRange FileRange
	TotalSize     int64
}

FileRangedGetResult models the result of getting a ranged file

type FileRangedGetter

type FileRangedGetter interface {
	GetRangedFileReader(
		name string,
		fileRange FileRange,
	) (*FileRangedGetResult, error)
}

FileRangedGetter defines the interface of a getter for files supportting getting file within a byte range

type PostFileRequest

type PostFileRequest struct {
	Action      string                 `json:"action"`
	ExtraFields map[string]interface{} `json:"extra-fields,omitempty"`
}

PostFileRequest models the POST request for upload asset file

type SignatureParser

type SignatureParser interface {
	ParseSignature(signed string, name string, expiredAt time.Time) (valid bool, err error)
}

SignatureParser parses a signed signature string

type Store

type Store interface {
	FileGetter
	FilePutter
	FilePostRequestGenerator
}

Store specify the interfaces of an asset store

func NewCloudStore

func NewCloudStore(
	appName string,
	host string,
	authToken string,
	publicURLPrefix string,
	privateURLPrefix string,
	public bool,
) (Store, error)

NewCloudStore creates a new cloud asset store

func NewFileStore

func NewFileStore(dir, prefix, secret string, public bool) Store

NewFileStore creates a new fileStore

func NewS3Store

func NewS3Store(
	accessKey string,
	secretKey string,
	regionName string,
	bucketName string,
	urlPrefix string,
	public bool,
) (Store, error)

NewS3Store returns a new s3Store

type URLSigner

type URLSigner interface {
	// SignedURL returns a url with access to the named file. If asset
	// store is private, the returned URL is a signed one, allowing access
	// to asset for a short period.
	SignedURL(name string) (string, error)
	IsSignatureRequired() bool
}

URLSigner signs a signature and returns a URL accessible to that asset.

type URLSignerStore

type URLSignerStore interface {
	Store
	URLSigner
}

URLSignerStore is an interface that is a union of Store and URLSigner.