rust

Documentation

Index

• Constants
• Variables
• func MakeRustLanguage(_ *Config) (language.Language, error)
• type CargoToml
  • func (c *CargoToml) MainFile() (string, error)
  • func (c *CargoToml) ModTree() (*ModTree, error)
• type Config
• type Language
  • func (l *Language) ParseExports(file *language.FileInfo) (*language.ExportsResult, error)
  • func (l *Language) ParseFile(id string) (*language.FileInfo, error)
  • func (l *Language) ParseImports(file *language.FileInfo) (*language.ImportsResult, error)
• type ModTree
  • func (m *ModTree) Search(modChain []string) *ModTree

Constants

const CargoTomlFile = "Cargo.toml"

Variables

var CachedRustFile = utils.Cached1In1OutErr(rust_grammar.Parse)

var Extensions = []string{
	"rs",
}

var MakeModTree = utils.Cached1In1OutErr(func(mainPath string) (*ModTree, error) {

	return makeModTree(mainPath, "crate", nil)
})

MakeModTree builds the ModTree given the main library/executable file path (src/lib.rs or src/main.rs).

Functions

func MakeRustLanguage

func MakeRustLanguage(_ *Config) (language.Language, error)

Types

type CargoToml

type CargoToml struct {
	PackageDefinition packageDefinition `toml:"package"`
	// It's [dev-]dependencies.
	Dependencies map[string]localDependency
	// contains filtered or unexported fields
}

func (*CargoToml) MainFile

func (c *CargoToml) MainFile() (string, error)

MainFile retrieves the main file of the workspace (e.g. src/lib.rs or src/main.rs).

func (*CargoToml) ModTree

func (c *CargoToml) ModTree() (*ModTree, error)

ModTree lazily builds the ModTree for this specific CargoToml.

First call to this function needs to parse the ModTree, subsequent calls are cached.

type Config

type Config struct{}

type Language

type Language struct{}

func (*Language) ParseExports

func (l *Language) ParseExports(file *language.FileInfo) (*language.ExportsResult, error)

func (*Language) ParseFile

func (l *Language) ParseFile(id string) (*language.FileInfo, error)

func (*Language) ParseImports

func (l *Language) ParseImports(file *language.FileInfo) (*language.ImportsResult, error)

type ModTree

type ModTree struct {
	Name     string
	Path     string
	Parent   *ModTree
	Children map[string]*ModTree
}

func (*ModTree) Search

func (m *ModTree) Search(modChain []string) *ModTree