rust

Documentation

Overview

Package rust provides Rust specific functionality for librarian.

Index

• Constants
• Variables
• func Add(lib *config.Library) *config.Library
• func Bump(ctx context.Context, library *config.Library, ...) error
• func DefaultLibraryName(api string) string
• func DefaultOutput(api, defaultOutput string) string
• func DeriveAPIPath(name string) string
• func Format(ctx context.Context, library *config.Library) error
• func Generate(ctx context.Context, cfg *config.Config, library *config.Library, ...) error
• func Install(ctx context.Context, tools *config.Tools) error
• func IsVeneer(lib *config.Library) bool
• func Keep(library *config.Library) ([]string, error)
• func Publish(ctx context.Context, cfg *config.Config, ...) error
• func ResolveDependencies(ctx context.Context, cfg *config.Config, lib *config.Library, ...) (*config.Config, error)
• func UpdateWorkspace(ctx context.Context) error
• type Cargo
• type CrateInfo

Constants

const DefaultVersion = "1.0.0"

DefaultVersion is the first version used for a new library. This is set on the initial `librarian add` for a new API.

Variables

var ErrMissingToolVersion = errors.New("cargo tool missing version")

ErrMissingToolVersion indicates a cargo tool entry is missing its version.

Functions

func Add

func Add(lib *config.Library) *config.Library

Add executes Rust-specific mutations of the given config.Library entry to be added to the librarian.yaml via `librarian add`.

Currently, it only sets the config.Library.Version property to the DefaultVersion for Rust.

func Bump

func Bump(ctx context.Context, library *config.Library, output, version, gitExe, lastTag string) error

Bump checks if a version bump is required and performs it. It returns without error if no bump is needed (version already updated since lastTag).

func DefaultLibraryName

func DefaultLibraryName(api string) string

DefaultLibraryName derives a library name from an api path. For example: google/cloud/secretmanager/v1 -> google-cloud-secretmanager-v1.

func DefaultOutput

func DefaultOutput(api, defaultOutput string) string

DefaultOutput derives an output path from an api path and default output. For example: google/cloud/secretmanager/v1 with default src/generated/ returns src/generated/cloud/secretmanager/v1.

func DeriveAPIPath

func DeriveAPIPath(name string) string

DeriveAPIPath derives an api path from a library name. For example: google-cloud-secretmanager-v1 -> google/cloud/secretmanager/v1.

func Format

func Format(ctx context.Context, library *config.Library) error

Format formats a generated Rust library. Must be called sequentially; parallel calls cause race conditions as cargo fmt runs cargo metadata, which competes for locks on the workspace Cargo.toml and Cargo.lock.

func Generate

func Generate(ctx context.Context, cfg *config.Config, library *config.Library, sources *sources.Sources) error

Generate generates a Rust client library.

func Install

func Install(ctx context.Context, tools *config.Tools) error

Install installs cargo tool dependencies defined in the tools configuration.

func IsVeneer

func IsVeneer(lib *config.Library) bool

IsVeneer reports whether the library has handwritten code wrapping generated code.

A library is a veneer when it has Rust module configuration. A library with no APIs and an explicit output is a veneer if its derived API path is not listed in sdk.yaml; libraries whose derived path appears in sdk.yaml are generated libraries whose APIs have not been populated yet (e.g. google-cloud-oslogin-common), not veneers.

func Keep

func Keep(library *config.Library) ([]string, error)

Keep returns the list of files to preserve when cleaning the output directory.

func Publish

func Publish(ctx context.Context, cfg *config.Config, dryRun, dryRunKeepGoing, skipSemverChecks bool) error

Publish finds all the crates that should be published. It can optionally run in dry-run mode, dry-run mode with continue on errors, and/or skip semver checks.

func ResolveDependencies

func ResolveDependencies(ctx context.Context, cfg *config.Config, lib *config.Library, sources *sources.Sources) (*config.Config, error)

ResolveDependencies automatically resolves Protobuf dependencies for a Rust library.

func UpdateWorkspace

func UpdateWorkspace(ctx context.Context) error

UpdateWorkspace updates dependencies for the entire Rust workspace.

Types

type Cargo

type Cargo struct {
	Package *CrateInfo `toml:"package"`
}

Cargo is a wrapper for CrateInfo for parsing Cargo.toml files.

type CrateInfo

type CrateInfo struct {
	Name    string `toml:"name"`
	Version string `toml:"version"`
	Publish bool   `toml:"publish"`
}

CrateInfo contains the package information.