opt

Documentation

Index

• type AddOptions
  • func (opts *AddOptions) Validate() error
• type CompileOptions
  • func DefaultCompileOptions() *CompileOptions
  • func MergeOptions(opts ...CompileOptions) CompileOptions
  • func WithEntries(entries []string) CompileOptions
  • func WithKclOption(opt kcl.Option) CompileOptions
  • func WithNoSumCheck(is bool) CompileOptions
  • func WithVendor(isVendor bool) CompileOptions
  • func (opts *CompileOptions) AddEntry(entry string)
  • func (opts *CompileOptions) Entries() []string
  • func (opts *CompileOptions) ExtendEntries(entries []string)
  • func (opts *CompileOptions) HasSettingsYaml() bool
  • func (opts *CompileOptions) IsVendor() bool
  • func (opts *CompileOptions) LogWriter() io.Writer
  • func (opts *CompileOptions) NoSumCheck() bool
  • func (opts *CompileOptions) PkgPath() string
  • func (opts *CompileOptions) SetEntries(entries []string)
  • func (opts *CompileOptions) SetHasSettingsYaml(hasSettingsYaml bool)
  • func (opts *CompileOptions) SetLogWriter(writer io.Writer)
  • func (opts *CompileOptions) SetNoSumCheck(noSumCheck bool)
  • func (opts *CompileOptions) SetPkgPath(pkgPath string)
  • func (opts *CompileOptions) SetVendor(isVendor bool)
• type GitOptions
  • func (opts *GitOptions) Validate() error
• type InitOptions
  • func (opts *InitOptions) Validate() error
• type LocalOptions
  • func (opts *LocalOptions) Validate() error
• type OciFetchOptions
• type OciManifestOptions
• type OciOptions
  • func ParseOciOptionFromOciUrl(url, tag string) (*OciOptions, *reporter.KpmEvent)
  • func ParseOciUrl(ociUrl string) (*OciOptions, *reporter.KpmEvent)
  • func (oci *OciOptions) AddStoragePathSuffix(pathPrefix string) string
  • func (opts *OciOptions) Validate() error
• type RegistryOptions

Types

type AddOptions

type AddOptions struct {
	LocalPath    string
	RegistryOpts RegistryOptions
	NoSumCheck   bool
}

func (*AddOptions) Validate

func (opts *AddOptions) Validate() error

type CompileOptions

type CompileOptions struct {
	*kcl.Option
	// contains filtered or unexported fields
}

CompileOptions is the input options of 'kpm run'.

func DefaultCompileOptions

func DefaultCompileOptions() *CompileOptions

DefaultCompileOptions returns a default CompileOptions.

func MergeOptions

func MergeOptions(opts ...CompileOptions) CompileOptions

MergeOptions will merge the input options.

func WithEntries

func WithEntries(entries []string) CompileOptions

WithEntries will add entries to the compiler.

func WithKclOption

func WithKclOption(opt kcl.Option) CompileOptions

WithKclOption will add a kcl option to the compiler.

func WithNoSumCheck

func WithNoSumCheck(is bool) CompileOptions

WithNoSumCheck will set the 'no_sum_check' flag.

func WithVendor

func WithVendor(isVendor bool) CompileOptions

WithEntry will add an entry to the compiler.

func (*CompileOptions) AddEntry

func (opts *CompileOptions) AddEntry(entry string)

AddEntry will add a compile entry file to the compiler.

func (*CompileOptions) Entries

func (opts *CompileOptions) Entries() []string

Entrirs will return the entries of the compiler.

func (*CompileOptions) ExtendEntries

func (opts *CompileOptions) ExtendEntries(entries []string)

ExtendEntries will extend the entries of the compiler.

func (*CompileOptions) HasSettingsYaml

func (opts *CompileOptions) HasSettingsYaml() bool

HasSettingsYaml will return the 'hasSettingsYaml' flag.

func (*CompileOptions) IsVendor

func (opts *CompileOptions) IsVendor() bool

IsVendor will return the 'isVendor' flag.

func (*CompileOptions) LogWriter

func (opts *CompileOptions) LogWriter() io.Writer

LogWriter will return the log writer of the compiler.

func (*CompileOptions) NoSumCheck

func (opts *CompileOptions) NoSumCheck() bool

NoSumCheck will return the 'no_sum_check' flag.

func (*CompileOptions) PkgPath

func (opts *CompileOptions) PkgPath() string

PkgPath will return the home path for a kcl package during compilation

func (*CompileOptions) SetEntries

func (opts *CompileOptions) SetEntries(entries []string)

SetEntries will set the entries of the compiler.

func (*CompileOptions) SetHasSettingsYaml

func (opts *CompileOptions) SetHasSettingsYaml(hasSettingsYaml bool)

SetHasSettingsYaml will set the 'hasSettingsYaml' flag.

func (*CompileOptions) SetLogWriter

func (opts *CompileOptions) SetLogWriter(writer io.Writer)

SetLogWriter will set the log writer of the compiler.

func (*CompileOptions) SetNoSumCheck

func (opts *CompileOptions) SetNoSumCheck(noSumCheck bool)

SetNoSumCheck will set the 'no_sum_check' flag.

func (*CompileOptions) SetPkgPath

func (opts *CompileOptions) SetPkgPath(pkgPath string)

SetPkgPath will set the home path for a kcl package during compilation

func (*CompileOptions) SetVendor

func (opts *CompileOptions) SetVendor(isVendor bool)

SetVendor will set the 'isVendor' flag.

type GitOptions

type GitOptions struct {
	Url    string
	Branch string
	Commit string
	Tag    string
}

func (*GitOptions) Validate

func (opts *GitOptions) Validate() error

type InitOptions

type InitOptions struct {
	Name     string
	InitPath string
}

Input options of 'kpm init'.

func (*InitOptions) Validate

func (opts *InitOptions) Validate() error

type LocalOptions

type LocalOptions struct {
	Path string
}

LocalOptions for local packages. kpm will find packages from local path.

func (*LocalOptions) Validate

func (opts *LocalOptions) Validate() error

type OciFetchOptions

type OciFetchOptions struct {
	oras.FetchBytesOptions
	OciOptions
}

OciFetchOptions is the input options of the api to fetch oci manifest.

type OciManifestOptions

type OciManifestOptions struct {
	Annotations map[string]string
}

type OciOptions

type OciOptions struct {
	Reg         string
	Repo        string
	Tag         string
	PkgName     string
	Annotations map[string]string
}

OciOptions for download oci packages. kpm will download packages from oci registry by '{Reg}/{Repo}/{PkgName}:{Tag}'.

func ParseOciOptionFromOciUrl

func ParseOciOptionFromOciUrl(url, tag string) (*OciOptions, *reporter.KpmEvent)

ParseOciOptionFromOciUrl will parse oci url into an 'OciOptions'. If the 'tag' is empty, ParseOciOptionFromOciUrl will take 'latest' as the default tag.

func ParseOciUrl

func ParseOciUrl(ociUrl string) (*OciOptions, *reporter.KpmEvent)

ParseOciUrl will parse 'oci://hostName/repoName:repoTag' into OciOptions without tag.

func (*OciOptions) AddStoragePathSuffix

func (oci *OciOptions) AddStoragePathSuffix(pathPrefix string) string

AddStoragePathSuffix will take 'Registry/Repo/Tag' as a path suffix. e.g. Take '/usr/test' as input, and oci options is

OciOptions {
  Reg: 'docker.io',
  Repo: 'test/testRepo',
  Tag: 'v0.0.1'
}

You will get a path '/usr/test/docker.io/test/testRepo/v0.0.1'.

func (*OciOptions) Validate

func (opts *OciOptions) Validate() error

type RegistryOptions

type RegistryOptions struct {
	Git   *GitOptions
	Oci   *OciOptions
	Local *LocalOptions
}