rust

Documentation

Overview

Package rust is the build planner for Rust projects.

Index

• Constants
• func GenerateDockerfile(meta types.PlanMeta) (string, error)
• func GetMeta(options GetMetaOptions) types.PlanMeta
• func NewIdentifier() plan.Identifier
• func NewPacker() packer.Packer
• type GetMetaOptions
• type TemplateContext

Constants

const ConfigPreStartCommand = "pre_start_command"

ConfigPreStartCommand is the key for the command before `CMD`. Useful for installing dependencies for runtime.

const ConfigRustAppDir = "rust.app_dir"

ConfigRustAppDir is the key for the directory of the application.

If this key is not set, the default value is the current directory – "/".

const ConfigRustAssets = "rust.assets"

ConfigRustAssets is the key for the assets of the application. It is an array.

The assets will be copied to the root of the application.

const ConfigRustEntry = "rust.entry"

ConfigRustEntry is the key for the binary entry name of the application.

If this key is not set, the default value is the binary with the submodule name. If there is no such submodule, it picks the first binary it found.

Functions

func GenerateDockerfile

func GenerateDockerfile(meta types.PlanMeta) (string, error)

GenerateDockerfile generates the Dockerfile for the Rust project.

func GetMeta

func GetMeta(options GetMetaOptions) types.PlanMeta

GetMeta gets the metadata of the Rust project.

func NewIdentifier

func NewIdentifier() plan.Identifier

NewIdentifier returns a new Rust identifier.

func NewPacker

func NewPacker() packer.Packer

NewPacker returns a new Rust packer.

Types

type GetMetaOptions

type GetMetaOptions struct {
	Src    afero.Fs
	Config plan.ImmutableProjectConfiguration
	// In Rust, the submodule name is the binary name.
	SubmoduleName string
}

GetMetaOptions is the options for GetMeta.

type TemplateContext

type TemplateContext struct {
	OpenSSL    bool
	Serverless bool
	Entry      string
	AppDir     string
	Assets     []string

	BuildCommand    string
	StartCommand    string
	PreStartCommand string
}

TemplateContext is the context for the Dockerfile template.