inspect

package

v0.0.0-...-d6be617 Latest Latest Go to latest Published: Apr 8, 2024 License: MIT Imports: 14 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/wedaly/gospelunk

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
type Relation
type RelationKind
- func RelationKindFromString(s string) (RelationKind, error)
- func RelationKindsFromStrings(relKindStrings []string) ([]RelationKind, error)
type RelationSlice
type Result
- func Inspect(loc file.Loc, searchDir string, includeRelKinds []RelationKind) (*Result, error)

Constants ¶

View Source

const (
	// The relation between a usage and its definition.
	RelationKindDef = RelationKind("definition")

	// The relation between a definition and its references.
	RelationKindRef = RelationKind("reference")

	// The relation between an interface and its implementation.
	RelationKindImpl = RelationKind("implementation")

	// The relation between an implementation and its interface.
	RelationKindIface = RelationKind("interface")
)

Variables ¶

View Source

var AllRelationKindStrings []string

View Source

var AllRelationKinds []RelationKind

Functions ¶

This section is empty.

Types ¶

type Relation ¶

type Relation struct {
	file.Loc
	Kind RelationKind
	Pkg  string
	Name string
}

Relation represents a relationship between an identifier to some other part of the codebase.

type RelationKind ¶

type RelationKind string

func RelationKindFromString ¶

func RelationKindFromString(s string) (RelationKind, error)

func RelationKindsFromStrings ¶

func RelationKindsFromStrings(relKindStrings []string) ([]RelationKind, error)

type RelationSlice ¶

type RelationSlice []Relation

func (RelationSlice) Len ¶

func (rs RelationSlice) Len() int

Len implements sort.Interface#Len

func (RelationSlice) Less ¶

func (rs RelationSlice) Less(i, j int) bool

Less implements sort.Interface#Less

func (RelationSlice) Swap ¶

func (rs RelationSlice) Swap(i, j int)

Swap implements sort.Interface#Swap

type Result ¶

type Result struct {
	Name      string
	Type      string
	Relations []Relation
}

func Inspect ¶

func Inspect(loc file.Loc, searchDir string, includeRelKinds []RelationKind) (*Result, error)

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL