conan

Documentation

Index

• Constants
• Variables
• type Conaninfo
  • func ParseConaninfo(r io.Reader) (*Conaninfo, error)
• type Metadata
  • func ParseConanfile(r io.Reader) (*Metadata, error)
• type PackageReference
  • func NewPackageReference(recipe *RecipeReference, reference, revision string) (*PackageReference, error)
  • func (r *PackageReference) AsKey() string
  • func (r *PackageReference) LinkName() string
  • func (r *PackageReference) RevisionOrDefault() string
  • func (r *PackageReference) WithRevision(revision string) *PackageReference
• type RecipeReference
  • func NewRecipeReference(name, version, user, channel, revision string) (*RecipeReference, error)
  • func (r *RecipeReference) AsKey() string
  • func (r *RecipeReference) LinkName() string
  • func (r *RecipeReference) RevisionOrDefault() string
  • func (r *RecipeReference) String() string
  • func (r *RecipeReference) WithRevision(revision string) *RecipeReference

Constants

const (
	PropertyRecipeUser       = "conan.recipe.user"
	PropertyRecipeChannel    = "conan.recipe.channel"
	PropertyRecipeRevision   = "conan.recipe.revision"
	PropertyPackageReference = "conan.package.reference"
	PropertyPackageRevision  = "conan.package.revision"
	PropertyPackageInfo      = "conan.package.info"
)

const (

	// DefaultRevision if no revision is specified
	DefaultRevision = "0"
)

Variables

var (
	ErrValidation = errors.New("Could not validate one or more reference fields")
)

Types

type Conaninfo

type Conaninfo struct {
	Settings     map[string]string   `json:"settings"`
	FullSettings map[string]string   `json:"full_settings"`
	Requires     []string            `json:"requires"`
	FullRequires []string            `json:"full_requires"`
	Options      map[string]string   `json:"options"`
	FullOptions  map[string]string   `json:"full_options"`
	RecipeHash   string              `json:"recipe_hash"`
	Environment  map[string][]string `json:"environment"`
}

Conaninfo represents infos of a Conan package

func ParseConaninfo

func ParseConaninfo(r io.Reader) (*Conaninfo, error)

type Metadata

type Metadata struct {
	Author        string   `json:"author,omitempty"`
	License       string   `json:"license,omitempty"`
	ProjectURL    string   `json:"project_url,omitempty"`
	RepositoryURL string   `json:"repository_url,omitempty"`
	Description   string   `json:"description,omitempty"`
	Keywords      []string `json:"keywords,omitempty"`
}

Metadata represents the metadata of a Conan package

func ParseConanfile

func ParseConanfile(r io.Reader) (*Metadata, error)

type PackageReference

type PackageReference struct {
	Recipe    *RecipeReference
	Reference string
	Revision  string
}

PackageReference represents a package of a recipe <Name>/<Version>@<User>/<Channel>#<Revision> <Reference>#<Revision>

func NewPackageReference

func NewPackageReference(recipe *RecipeReference, reference, revision string) (*PackageReference, error)

func (*PackageReference) AsKey

func (r *PackageReference) AsKey() string

AsKey builds the additional key for the package file

func (*PackageReference) LinkName

func (r *PackageReference) LinkName() string

func (*PackageReference) RevisionOrDefault

func (r *PackageReference) RevisionOrDefault() string

func (*PackageReference) WithRevision

func (r *PackageReference) WithRevision(revision string) *PackageReference

type RecipeReference

type RecipeReference struct {
	Name     string
	Version  string
	User     string
	Channel  string
	Revision string
}

RecipeReference represents a recipe <Name>/<Version>@<User>/<Channel>#<Revision>

func NewRecipeReference

func NewRecipeReference(name, version, user, channel, revision string) (*RecipeReference, error)

func (*RecipeReference) AsKey

func (r *RecipeReference) AsKey() string

AsKey builds the additional key for the package file

func (*RecipeReference) LinkName

func (r *RecipeReference) LinkName() string

func (*RecipeReference) RevisionOrDefault

func (r *RecipeReference) RevisionOrDefault() string

func (*RecipeReference) String

func (r *RecipeReference) String() string

func (*RecipeReference) WithRevision

func (r *RecipeReference) WithRevision(revision string) *RecipeReference