option

Documentation

Index

• type Bound
• type Option
  • func CaseInsensitive(val bool) Option
  • func WithBounds(val *Bound) Option
  • func WithDataDir(val string) Option
  • func WithDataPrefix(val string) Option
  • func WithDataURL(val string) Option
  • func WithEntity(val interface{}) Option
  • func WithEntityDirName(val string) Option
  • func WithFilesDir(val string) Option
  • func WithIndexBy(val string) Option
  • func WithJWTSecret(val string) Option
  • func WithProviderAddr(val string) Option
  • func WithServiceUser(val config.ServiceUser) Option
  • func WithTypeName(val string) Option
• type Options

Types

type Bound

type Bound struct {
	Lower, Upper int64
}

Bound represents a lower and upper bound range for an index. todo: if we would like to provide an upper bound then we would need to deal with ranges, in which case this is why the upper bound attribute is here.

type Option

type Option func(o *Options)

Option defines a single option function.

func CaseInsensitive

func CaseInsensitive(val bool) Option

CaseInsensitive sets the CaseInsensitive field.

func WithBounds

func WithBounds(val *Bound) Option

WithBounds sets the Bounds field.

func WithDataDir

func WithDataDir(val string) Option

WithDataDir sets the DataDir option.

func WithDataPrefix

func WithDataPrefix(val string) Option

WithDataPrefix sets the DataPrefix field.

func WithDataURL

func WithDataURL(val string) Option

WithDataURL sets the DataURl field.

func WithEntity

func WithEntity(val interface{}) Option

WithEntity sets the Entity field.

func WithEntityDirName

func WithEntityDirName(val string) Option

WithEntityDirName sets the EntityDirName field.

func WithFilesDir

func WithFilesDir(val string) Option

WithFilesDir sets the option FilesDir.

func WithIndexBy

func WithIndexBy(val string) Option

WithIndexBy sets the option IndexBy.

func WithJWTSecret

func WithJWTSecret(val string) Option

WithJWTSecret sets the JWTSecret field.

func WithProviderAddr

func WithProviderAddr(val string) Option

WithProviderAddr sets the option ProviderAddr.

func WithServiceUser

func WithServiceUser(val config.ServiceUser) Option

WithServiceUser sets the option ServiceUser.

func WithTypeName

func WithTypeName(val string) Option

WithTypeName sets the TypeName option.

type Options

type Options struct {
	CaseInsensitive bool
	Bound           *Bound

	// Disk Options
	TypeName      string
	IndexBy       string
	FilesDir      string
	IndexBaseDir  string
	DataDir       string
	EntityDirName string
	Entity        interface{}

	// CS3 options
	DataURL      string
	DataPrefix   string
	JWTSecret    string
	ProviderAddr string
	ServiceUser  config.ServiceUser
}

Options defines the available options for this package.