specifier

Documentation

Index

• type KindType
• type Specifier
  • func Parse(specifierString string) (Specifier, error)
  • func (s Specifier) IsToothVersionSpecified() (bool, error)
  • func (s Specifier) Kind() KindType
  • func (s Specifier) String() string
  • func (s Specifier) ToothArchivePath() (path.Path, error)
  • func (s Specifier) ToothRepoPath() (string, error)
  • func (s Specifier) ToothVersion() (semver.Version, error)

Types

type KindType

type KindType int

KindType is an enum that represents the type of a specifier.

const (
	ToothArchiveKind KindType = iota
	ToothRepoKind
)

type Specifier

type Specifier struct {
	// contains filtered or unexported fields
}

Specifier is a type that can be used to specify a tooth url/file or a requirement.

func Parse

func Parse(specifierString string) (Specifier, error)

Parse creates a new specifier from the given string.

func (Specifier) IsToothVersionSpecified

func (s Specifier) IsToothVersionSpecified() (bool, error)

IsToothVersionSpecified returns whether the specifier has a tooth version.

func (Specifier) Kind

func (s Specifier) Kind() KindType

Kind returns the type of the specifier.

func (Specifier) String

func (s Specifier) String() string

String returns the string representation of the specifier.

func (Specifier) ToothArchivePath

func (s Specifier) ToothArchivePath() (path.Path, error)

ToothArchivePath returns the path of the tooth archive.

func (Specifier) ToothRepoPath

func (s Specifier) ToothRepoPath() (string, error)

ToothRepoPath returns the tooth repo of the specifier.

func (Specifier) ToothVersion

func (s Specifier) ToothVersion() (semver.Version, error)

ToothVersion returns the version of the tooth.