s3

Documentation

Overview

*Copyright (c) 2022, kaydxh * *Permission is hereby granted, free of charge, to any person obtaining a copy *of this software and associated documentation files (the "Software"), to deal *in the Software without restriction, including without limitation the rights *to use, copy, modify, merge, publish, distribute, sublicense, and/or sell *copies of the Software, and to permit persons to whom the Software is *furnished to do so, subject to the following conditions: * *The above copyright notice and this permission notice shall be included in all *copies or substantial portions of the Software. * *THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR *IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, *FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE *AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER *LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, *OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE *SOFTWARE.

*Copyright (c) 2022, kaydxh * *Permission is hereby granted, free of charge, to any person obtaining a copy *of this software and associated documentation files (the "Software"), to deal *in the Software without restriction, including without limitation the rights *to use, copy, modify, merge, publish, distribute, sublicense, and/or sell *copies of the Software, and to permit persons to whom the Software is *furnished to do so, subject to the following conditions: * *The above copyright notice and this permission notice shall be included in all *copies or substantial portions of the Software. * *THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR *IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, *FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE *AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER *LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, *OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE *SOFTWARE.

*Copyright (c) 2022, kaydxh * *Permission is hereby granted, free of charge, to any person obtaining a copy *of this software and associated documentation files (the "Software"), to deal *in the Software without restriction, including without limitation the rights *to use, copy, modify, merge, publish, distribute, sublicense, and/or sell *copies of the Software, and to permit persons to whom the Software is *furnished to do so, subject to the following conditions: * *The above copyright notice and this permission notice shall be included in all *copies or substantial portions of the Software. * *THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR *IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, *FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE *AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER *LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, *OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE *SOFTWARE.

*Copyright (c) 2022, kaydxh * *Permission is hereby granted, free of charge, to any person obtaining a copy *of this software and associated documentation files (the "Software"), to deal *in the Software without restriction, including without limitation the rights *to use, copy, modify, merge, publish, distribute, sublicense, and/or sell *copies of the Software, and to permit persons to whom the Software is *furnished to do so, subject to the following conditions: * *The above copyright notice and this permission notice shall be included in all *copies or substantial portions of the Software. * *THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR *IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, *FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE *AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER *LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, *OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE *SOFTWARE.

Index

• Variables
• type CompletedConfig
  • func (c CompletedConfig) New(ctx context.Context) (*blob.Bucket, error)
• type Config
  • func NewConfig(options ...ConfigOption) *Config
  • func (o *Config) ApplyOptions(options ...ConfigOption) *Config
  • func (c *Config) Complete() CompletedConfig
• type ConfigOption
  • func WithViper(v *viper.Viper) ConfigOption
• type ConfigOptionFunc
• type EmptyConfigOption
• type EmptyStorageOption
• type S3
  • func (*S3) Descriptor() ([]byte, []int)
  • func (x *S3) GetEnabled() bool
  • func (x *S3) GetSecretId() string
  • func (x *S3) GetSecretKey() string
  • func (x *S3) GetUrl() string
  • func (*S3) ProtoMessage()
  • func (x *S3) ProtoReflect() protoreflect.Message
  • func (x *S3) Reset()
  • func (x *S3) String() string
• type Storage
  • func NewStorage(ctx context.Context, conf StorageConfig, opts ...StorageOption) (*Storage, error)
  • func (o *Storage) ApplyOptions(options ...StorageOption) *Storage
• type StorageConfig
  • func ParseUrl(rawUrl string) (*StorageConfig, error)
• type StorageOption
  • func WithPrefixPath(prefixPath string) StorageOption
• type StorageOptionFunc

Variables

var (
	ErrNotEnabled = errors.New("not enabled")
)

var File_pkg_storage_s3_s3_proto protoreflect.FileDescriptor

Types

type CompletedConfig

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

func (CompletedConfig) New

func (c CompletedConfig) New(ctx context.Context) (*blob.Bucket, error)

type Config

type Config struct {
	Proto S3
	// contains filtered or unexported fields
}

func NewConfig

func NewConfig(options ...ConfigOption) *Config

func (*Config) ApplyOptions

func (o *Config) ApplyOptions(options ...ConfigOption) *Config

func (*Config) Complete

func (c *Config) Complete() CompletedConfig

Complete set default ServerRunOptions.

type ConfigOption

type ConfigOption interface {
	// contains filtered or unexported methods
}

A ConfigOption sets options.

func WithViper

func WithViper(v *viper.Viper) ConfigOption

type ConfigOptionFunc

type ConfigOptionFunc func(*Config)

ConfigOptionFunc wraps a function that modifies Client into an implementation of the ConfigOption interface.

type EmptyConfigOption

type EmptyConfigOption struct{}

EmptyConfigOption does not alter the configuration. It can be embedded in another structure to build custom options.

This API is EXPERIMENTAL.

type EmptyStorageOption

type EmptyStorageOption struct{}

EmptyStorageUrlOption does not alter the Storageuration. It can be embedded in another structure to build custom options.

This API is EXPERIMENTAL.

type S3

type S3 struct {
	Enabled   bool   `protobuf:"varint,1,opt,name=enabled,proto3" json:"enabled,omitempty"`
	Url       string `protobuf:"bytes,2,opt,name=url,proto3" json:"url,omitempty"`
	SecretId  string `protobuf:"bytes,3,opt,name=secret_id,json=secretId,proto3" json:"secret_id,omitempty"`
	SecretKey string `protobuf:"bytes,4,opt,name=secret_key,json=secretKey,proto3" json:"secret_key,omitempty"`
	// contains filtered or unexported fields
}

func (*S3) Descriptor

func (*S3) Descriptor() ([]byte, []int)

Deprecated: Use S3.ProtoReflect.Descriptor instead.

func (*S3) GetEnabled

func (x *S3) GetEnabled() bool

func (*S3) GetSecretId

func (x *S3) GetSecretId() string

func (*S3) GetSecretKey

func (x *S3) GetSecretKey() string

func (*S3) GetUrl

func (x *S3) GetUrl() string

func (*S3) ProtoMessage

func (*S3) ProtoMessage()

func (*S3) ProtoReflect

func (x *S3) ProtoReflect() protoreflect.Message

func (*S3) Reset

func (x *S3) Reset()

func (*S3) String

func (x *S3) String() string

type Storage

type Storage struct {
	Conf StorageConfig
	*blob.Bucket
	// contains filtered or unexported fields
}

func NewStorage

func NewStorage(ctx context.Context, conf StorageConfig, opts ...StorageOption) (*Storage, error)

func (*Storage) ApplyOptions

func (o *Storage) ApplyOptions(options ...StorageOption) *Storage

type StorageConfig

type StorageConfig struct {
	// 机房分布区域, cos的数据存放在这些地域的存储桶中
	Region string
	// 存储桶名字,存储桶是对象的载体,可理解为存放对象的容器
	BucketName string
	// 对象被存放到存储桶中,用户可通过访问域名访问和下载对象
	Endpoint string
	// 与账户对应的ID
	AppId string
	// 密钥
	SecretId     string
	SecretKey    string
	SessionToken string

	DisableSSL bool
}

url: http://examplebucket-1250000000.cos.ap-beijing.myqcloud.com

func ParseUrl

func ParseUrl(rawUrl string) (*StorageConfig, error)

url: http://examplebucket-1250000000.cos.ap-beijing.myqcloud.com

type StorageOption

type StorageOption interface {
	// contains filtered or unexported methods
}

A StorageOption sets options.

func WithPrefixPath

func WithPrefixPath(prefixPath string) StorageOption

type StorageOptionFunc

type StorageOptionFunc func(*Storage)

StorageOptionFunc wraps a function that modifies Storage into an implementation of the StorageOption interface.