source

Documentation

Index

• Variables
• type Driver
• type Option
  • func WithBucket(bucket string) Option
  • func WithClient(client *s3.Client) Option
  • func WithDatasource(datasource string) Option
  • func WithDir(dir string) Option
  • func WithDriver(driver Driver) Option
  • func WithFrom(fs fs.ReadFileFS) Option
  • func WithGORMDriver(driver string) Option
  • func WithGORMDsn(dsn string) Option
  • func WithMongoDBCollection(collection string) Option
  • func WithMongoDBName(name string) Option
  • func WithMongoDBURL(url string) Option
  • func WithName(file string) Option
  • func WithProjectName(projectName string) Option
  • func WithProvider(provider Provider) Option
  • func WithRegion(region string) Option
  • func WithTimeout(timeout time.Duration) Option
• type Options
  • func DefaultOptions() *Options
• type Provider
• type Scheme
  • func (s Scheme) String() string
• type Sourcer

Variables

var Extends = []Scheme{SchemeYaml, SchemeYml, SchemeJSOM}

Extends extends

Types

type Driver

type Driver interface {
	GenerateBytes() ([]byte, error)
	GetExtend() Scheme
}

type Option

type Option func(*Options)

Option option

func WithBucket

func WithBucket(bucket string) Option

WithBucket set s3 bucket

func WithClient

func WithClient(client *s3.Client) Option

WithClient set s3 client

func WithDatasource

func WithDatasource(datasource string) Option

WithDatasource set datasource

func WithDir

func WithDir(dir string) Option

WithDir set dir

func WithDriver

func WithDriver(driver Driver) Option

WithDriver set driver

func WithFrom

func WithFrom(fs fs.ReadFileFS) Option

WithFrom set embed.FS

func WithGORMDriver

func WithGORMDriver(driver string) Option

func WithGORMDsn

func WithGORMDsn(dsn string) Option

func WithMongoDBCollection

func WithMongoDBCollection(collection string) Option

WithMongoDBCollection set mongodb collection

func WithMongoDBName

func WithMongoDBName(name string) Option

WithMongoDBName set mongodb name

func WithMongoDBURL

func WithMongoDBURL(url string) Option

WithMongoDBURL set mongodb url

func WithName

func WithName(file string) Option

WithName set config name

func WithProjectName

func WithProjectName(projectName string) Option

WithProjectName set projectName

func WithProvider

func WithProvider(provider Provider) Option

WithProvider set provider

func WithRegion

func WithRegion(region string) Option

WithRegion set s3 region

func WithTimeout

func WithTimeout(timeout time.Duration) Option

WithTimeout set s3 client timeout

type Options

type Options struct {
	Provider          Provider
	Driver            Driver
	Name              string
	Extend            Scheme
	Dir               string
	Region            string
	Bucket            string
	ProjectName       string
	Timeout           time.Duration
	Client            *s3.Client
	FS                fs.ReadFileFS
	MongoDBURL        string
	MongoDBName       string
	MongoDBCollection string
	Datasource        string
	GORMDriver        string
	GORMDsn           string
}

Options options

func DefaultOptions

func DefaultOptions() *Options

DefaultOptions default options

type Provider

type Provider string

Provider provider

const (
	// FS fs
	FS Provider = "fs"
	// Local local
	Local Provider = "local"
	// S3 s3
	S3 Provider = "s3"
	// MGDB mongodb
	MGDB Provider = "mgdb"
	// GORM gorm
	GORM Provider = "gorm"
)

type Scheme

type Scheme string

Scheme scheme

const (
	// SchemeYaml yaml
	SchemeYaml Scheme = "yaml"
	// SchemeYml yml
	SchemeYml Scheme = "yml"
	// SchemeJSOM json
	SchemeJSOM Scheme = "json"
)

func (Scheme) String

func (s Scheme) String() string

String string

type Sourcer

type Sourcer interface {
	fs.ReadFileFS
	GetExtend() Scheme
}

Sourcer source interface