Crate forc_pkg

Building, locking, fetching and updating sway projects as Forc packages.

A forc package represents a Sway project with a Forc.toml manifest file declared at its root. The project should consist of one or more Sway modules under a src directory. It may also declare a set of forc package dependencies within its manifest.

Re-exports

pub use lock::Lock;

pub use manifest::Manifest;

pub use manifest::ManifestFile;

Modules

lock

manifest

Structs

BuildConfig

Parameters to pass through to the sway_core::BuildConfig during compilation.

BuildPlan

Represents the full build plan for a project.

Compiled

The result of successfully compiling a package.

Pinned

A package uniquely identified by name along with its pinned source.

PinnedId

A unique ID for a pinned package.

Pkg

A package uniquely identified by name along with its source.

SourceGit

A git repo with a Forc.toml manifest at its root.

SourceGitPinned

A pinned instance of a git source.

SourceRegistry

A package from the official registry.

SourceRegistryPinned

A pinned instance of the registry source.

Enums

GitReference

Used to distinguish between types of git references.

Source

Specifies a base source for a package.

SourceGitPinnedParseError

Error returned upon failed parsing of SourceGitPinned::from_str.

SourcePinned

A pinned instance of the package source.

Functions

build

Build an entire forc package and return the compiled output.

compilation_order

The pkg::Graph is of a -> b where a depends on b. We can determine compilation order by performing a toposort of the graph with reversed weights. The resulting order ensures all dependencies are always compiled before their dependents.

compile

Compiles the given package.

dependency_namespace

Builds the dependency namespace for the package at the given node index within the graph.

fetch_git

Fetch the repo at the given git package’s URL and checkout the pinned commit.

fetch_id

Produce a unique ID for a particular fetch pass.

find_dir_within

The same as find_within, but returns the package’s project directory.

find_within

Attempt to find a Forc.toml with the given project name within the given directory.

fuel_core_not_running

Format an error message if a given URL fails to produce a working node.

git_commit_path

The path to which a git package commit should be checked out.

graph_to_path_map

Given graph of pinned dependencies and the directory for the root node, produce a path map containing the path to the local source for every node in the graph.

manifest_file_missing

Format an error message for an absent Forc.toml.

parsing_failed

Format an error message for failed parsing of a manifest.

pin_git

Pin the given git-sourced package.

sway_build_config

Given a forc_pkg::BuildConfig, produce the necessary sway_core::BuildConfig required for compilation.

wrong_program_type

Format an error message if an incorrect program type is present.

Type Definitions

DependencyName

The name specified on the left hand side of the = in a depenedency declaration under [dependencies] within a forc manifest.

Graph

NodeIx

PathMap