Documentation
¶
Overview ¶
Package rust provides Rust specific functionality for librarian.
Index ¶
- 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, library *config.Library, sources *source.Sources) error
- func Keep(library *config.Library) ([]string, error)
- func Publish(ctx context.Context, config *config.Release, ...) error
- func UpdateWorkspace(ctx context.Context) error
- type Cargo
- type CrateInfo
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Bump ¶ added in v0.8.1
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 ¶ added in v0.8.1
DefaultLibraryName derives a library name from an api path. For example: google/cloud/secretmanager/v1 -> google-cloud-secretmanager-v1.
func DefaultOutput ¶
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 ¶ added in v0.8.1
DeriveAPIPath derives an api path from a library name. For example: google-cloud-secretmanager-v1 -> google/cloud/secretmanager/v1.
func Format ¶
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 Publish ¶
func Publish(ctx context.Context, config *config.Release, 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 UpdateWorkspace ¶ added in v0.8.1
UpdateWorkspace updates dependencies for the entire Rust workspace.
Source Files