getter

Documentation

Index

• type FileFetcher
• type Getter
  • func New(logger *log.Logger, useRemoteFS bool, accessKey, accessSecret string) *Getter
  • func (g *Getter) FetchFile(localPath, host, bucket, key string) (io.ReadCloser, Source, error)
• type Source

Types

type FileFetcher

type FileFetcher interface {
	FetchFile(localPath, host, bucket, key string) (io.ReadCloser, Source, error)
}

FileFetcher allows us to get a ReadCloser, the source (remote/local), or an error when attempting to get a file from either local or remote storage

type Getter

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

Getter contains unexported fields allowing the local or remote fetching of files

func New

func New(logger *log.Logger, useRemoteFS bool, accessKey, accessSecret string) *Getter

New creates a instatialized Getter that can get files locally or remotely. useRemoteFS tells us if the service is configured to use the remote file system. accessKey and accessSecret are authentication parts for the remote file system.

func (*Getter) FetchFile

func (g *Getter) FetchFile(localPath, host, bucket, key string) (io.ReadCloser, Source, error)

FetchFile will reach out to s3 or use the local file system to retrieve an email file

type Source

type Source string

Source allows us to have a type safe return value specifying if a file was remote or local

const (
	// Local signifies we are using a local file source
	Local Source = "local"
	//Remote signifies we are using a remote file source
	Remote Source = "remote"
)