cargo

Documentation

Overview

Package cargo contains helper functions for building Rust applications using cargo.

Index

• func Build(env env.ExecEnv, release bool, target string, features []string) (string, error)
• type Dependency
  • func (d *Dependency) HasFeature(feature string) bool
• type Metadata
  • func GetMetadata(env env.ExecEnv) (*Metadata, error)
  • func (m *Metadata) FindDependency(name string) *Dependency

Functions

func Build

func Build(env env.ExecEnv, release bool, target string, features []string) (string, error)

Build builds a Rust program using `cargo` in the current working directory.

Types

type Dependency

type Dependency struct {
	Name     string   `json:"name"`
	Features []string `json:"features"`
}

Dependency is the metadata about a dependency.

func (*Dependency) HasFeature

func (d *Dependency) HasFeature(feature string) bool

HasFeature returns true iff the given feature is present among the features.

type Metadata

type Metadata struct {
	Name         string
	Version      string
	Dependencies []Dependency
}

Metadata is the cargo package metadata.

func GetMetadata

func GetMetadata(env env.ExecEnv) (*Metadata, error)

GetMetadata queries `cargo` for metadata of the package in the current working directory.

func (*Metadata) FindDependency

func (m *Metadata) FindDependency(name string) *Dependency

FindDependency finds the first dependency with the given name and returns it. Iff no such dependency can be found, it returns nil.