indexer

Documentation

Overview

Package indexer contains the types and functions related to the ConanCenter indexer

Index

• type IndexData
  • func NewFromProperties(ref types.Reference, props []servicesUtils.Property) *IndexData
  • func (data *IndexData) SetForce(value bool)
• type Package
  • func NewPackageUsingProperties(pkg types.Package, props []servicesUtils.Property) *Package
  • func (pkg *Package) AddSetting(key string, value string)

Types

type IndexData

type IndexData struct {
	User           string `json:"user"`
	Channel        string `json:"channel"`
	RecipeRevision string `json:"recipe_revision"`

	Name        string `json:"name,omitempty"`
	Version     string `json:"version,omitempty"`
	Description string `json:"description,omitempty"`
	License     string `json:"license,omitempty"`
	Homepage    string `json:"homepage,omitempty"`
	URL         string `json:"giturl,omitempty"`
	Topics      string `json:"topics,omitempty"`

	Requires []string  `json:"requires"`
	Packages []Package `json:"packages"`

	Force         bool `json:"force"`
	ForceRequires bool `json:"force_requires"`
	ForceSettings bool `json:"force_settings"`
}

IndexData is the structure with all the information.

func NewFromProperties

func NewFromProperties(ref types.Reference, props []servicesUtils.Property) *IndexData

NewFromProperties creates a `IndexData` and populates it with Artifactory properties

func (*IndexData) SetForce

func (data *IndexData) SetForce(value bool)

SetForce sets the value of the `force` attribute and related ones.

type Package

type Package struct {
	PackageID       string            `json:"package_id"`
	Version         string            `json:"version"`
	PackageRevision string            `json:"package_revision"`
	Settings        map[string]string `json:"settings,omitempty"`
	Requires        []string          `json:"requires,omitempty"`
}

Package contains information about a single packageID inside the `IndexData`

func NewPackageUsingProperties

func NewPackageUsingProperties(pkg types.Package, props []servicesUtils.Property) *Package

NewPackageUsingProperties creates a `Package` instance and initializes its members

func (*Package) AddSetting

func (pkg *Package) AddSetting(key string, value string)

AddSetting add the key-value pair for a settings, taking into account some key transformations.