storage

Documentation

Index

• Constants
• Variables
• func AWSCredentialsFromChain(cpcs []*CredentialsProviderConfig) (*credentials.Credentials, error)
• func StoreFromStorageConfig(storageConfig *StorageConfig, logger log.Logger) (storage.NamedStore, error)
• type CredentialsProviderConfig
  • func ProviderConfig(provider credentials.Provider) (*CredentialsProviderConfig, error)
• type FileSystemConfig
• type GCSConfig
• type IPFSConfig
• type ProviderName
• type S3Config
• type SharedCredentialsProviderConfig
  • func (scpc *SharedCredentialsProviderConfig) Provider() (credentials.Provider, error)
• type StaticProviderConfig
  • func (spc *StaticProviderConfig) Provider() (credentials.Provider, error)
• type StorageConfig
  • func ConfigFromString(tomlString string) (*StorageConfig, error)
  • func DefaultFileSystemConfig() *StorageConfig
  • func DefaultGCSConfig() *StorageConfig
  • func DefaultIPFSConfig() *StorageConfig
  • func DefaultMemoryConfig() *StorageConfig
  • func DefaultS3Config() *StorageConfig
  • func NewFileSystemConfig(addressEncoding, rootDirectory string) *StorageConfig
  • func NewGCSConfig(addressEncoding, gcsBucket string) (*StorageConfig, error)
  • func NewIPFSConfig(addressEncoding, proto, address, port string) *StorageConfig
  • func NewMemoryConfig(addressEncoding string) *StorageConfig
  • func NewS3Config(addressEncoding, s3Bucket, s3Prefix, region string, ...) (*StorageConfig, error)
  • func NewStorageConfig(storageType StorageType, addressEncoding string) *StorageConfig
  • func (storageConfig *StorageConfig) TOMLString() string
• type StorageType

Constants

const (
	EnvProviderName               = "env"
	SharedCredentialsProviderName = "shared"
	StaticProviderName            = "static"
	RemoteProviderName            = "remote"
)

const DefaultAddressEncodingName = storage.Base64EncodingName

Variables

var DefaultConfig = NewMemoryConfig(DefaultAddressEncodingName)

Functions

func AWSCredentialsFromChain

func AWSCredentialsFromChain(cpcs []*CredentialsProviderConfig) (*credentials.Credentials, error)

func StoreFromStorageConfig

func StoreFromStorageConfig(storageConfig *StorageConfig,
	logger log.Logger) (storage.NamedStore, error)

Types

type CredentialsProviderConfig

type CredentialsProviderConfig struct {
	Provider string
	*SharedCredentialsProviderConfig
	*StaticProviderConfig
}

func ProviderConfig

func ProviderConfig(provider credentials.Provider) (*CredentialsProviderConfig, error)

type FileSystemConfig

type FileSystemConfig struct {
	RootDirectory string
}

type GCSConfig

type GCSConfig struct {
	GCSBucket string
}

type IPFSConfig

type IPFSConfig struct {
	Protocol string
	Address  string
	Port     string
}

type ProviderName

type ProviderName string

type S3Config

type S3Config struct {
	S3Bucket                 string
	Prefix                   string
	Region                   string
	CredentialsProviderChain []*CredentialsProviderConfig
}

type SharedCredentialsProviderConfig

type SharedCredentialsProviderConfig struct {
	Filename string
	Profile  string
}

func (*SharedCredentialsProviderConfig) Provider

func (scpc *SharedCredentialsProviderConfig) Provider() (credentials.Provider, error)

type StaticProviderConfig

type StaticProviderConfig struct {
	AccessKeyID     string
	SecretAccessKey string
	SessionToken    string
}

Almost the same a credentials.Value

func (*StaticProviderConfig) Provider

func (spc *StaticProviderConfig) Provider() (credentials.Provider, error)

type StorageConfig

type StorageConfig struct {
	// Acts a string enum
	StorageType StorageType
	// Address encoding name
	AddressEncoding string
	// Embedding a pointer to each type of config struct allows us to access the
	// relevant one, while at the same time those that are left as nil will be
	// omitted from being serialised.
	*FileSystemConfig
	*S3Config
	*GCSConfig
	*IPFSConfig
}

func ConfigFromString

func ConfigFromString(tomlString string) (*StorageConfig, error)

func DefaultFileSystemConfig

func DefaultFileSystemConfig() *StorageConfig

func DefaultGCSConfig

func DefaultGCSConfig() *StorageConfig

func DefaultIPFSConfig

func DefaultIPFSConfig() *StorageConfig

func DefaultMemoryConfig

func DefaultMemoryConfig() *StorageConfig

func DefaultS3Config

func DefaultS3Config() *StorageConfig

func NewFileSystemConfig

func NewFileSystemConfig(addressEncoding, rootDirectory string) *StorageConfig

func NewGCSConfig

func NewGCSConfig(addressEncoding, gcsBucket string) (*StorageConfig, error)

func NewIPFSConfig

func NewIPFSConfig(addressEncoding, proto, address, port string) *StorageConfig

func NewMemoryConfig

func NewMemoryConfig(addressEncoding string) *StorageConfig

func NewS3Config

func NewS3Config(addressEncoding, s3Bucket, s3Prefix, region string,
	providers ...credentials.Provider) (*StorageConfig, error)

func NewStorageConfig

func NewStorageConfig(storageType StorageType, addressEncoding string) *StorageConfig

func (*StorageConfig) TOMLString

func (storageConfig *StorageConfig) TOMLString() string

type StorageType

type StorageType string

const (
	Unspecified StorageType = ""
	Memory      StorageType = "memory"
	Filesystem  StorageType = "filesystem"
	S3          StorageType = "s3"
	GCS         StorageType = "gcs"
	IPFS        StorageType = "ipfs"
)