types

Documentation

Index

• type Dependencies
  • func (deps Dependencies) Len() int
  • func (deps Dependencies) Less(i, j int) bool
  • func (deps Dependencies) Swap(i, j int)
• type Dependency
• type ExternalRef
• type Libraries
  • func (libs Libraries) Len() int
  • func (libs Libraries) Less(i, j int) bool
  • func (libs Libraries) Swap(i, j int)
• type Library
• type Location
• type Locations
  • func (locs Locations) Len() int
  • func (locs Locations) Less(i, j int) bool
  • func (locs Locations) Swap(i, j int)
• type Parser
• type RefType
• type Relationship
  • func (r Relationship) MarshalJSON() ([]byte, error)
  • func (r Relationship) String() string
  • func (r *Relationship) UnmarshalJSON(data []byte) error

Types

type Dependencies

type Dependencies []Dependency

func (Dependencies) Len

func (deps Dependencies) Len() int

func (Dependencies) Less

func (deps Dependencies) Less(i, j int) bool

func (Dependencies) Swap

func (deps Dependencies) Swap(i, j int)

type Dependency

type Dependency struct {
	ID        string
	DependsOn []string
}

type ExternalRef

type ExternalRef struct {
	Type RefType
	URL  string
}

type Libraries

type Libraries []Library

func (Libraries) Len

func (libs Libraries) Len() int

func (Libraries) Less

func (libs Libraries) Less(i, j int) bool

func (Libraries) Swap

func (libs Libraries) Swap(i, j int)

type Library

type Library struct {
	ID                 string `json:",omitempty"`
	Name               string
	Version            string
	Dev                bool          `json:",omitempty"`
	Relationship       Relationship  `json:",omitempty"`
	License            string        `json:",omitempty"`
	ExternalReferences []ExternalRef `json:",omitempty"`
	Locations          Locations     `json:",omitempty"`
	FilePath           string        `json:",omitempty"` // Required to show nested jars
}

type Location

type Location struct {
	StartLine int `json:",omitempty"`
	EndLine   int `json:",omitempty"`
}

Location in lock file

type Locations

type Locations []Location

func (Locations) Len

func (locs Locations) Len() int

func (Locations) Less

func (locs Locations) Less(i, j int) bool

func (Locations) Swap

func (locs Locations) Swap(i, j int)

type Parser

type Parser interface {
	// Parse parses the dependency file
	Parse(r xio.ReadSeekerAt) ([]Library, []Dependency, error)
}

type RefType

type RefType string

const (
	RefVCS   RefType = "vcs"
	RefOther RefType = "other"
)

type Relationship

type Relationship int

const (
	RelationshipUnknown Relationship = iota
	RelationshipRoot
	RelationshipDirect
	RelationshipIndirect
)

func (Relationship) MarshalJSON

func (r Relationship) MarshalJSON() ([]byte, error)

func (Relationship) String

func (r Relationship) String() string

func (*Relationship) UnmarshalJSON

func (r *Relationship) UnmarshalJSON(data []byte) error