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::BuildProfile;
• pub use manifest::PackageManifest;
• pub use manifest::PackageManifestFile;
• pub use manifest::WorkspaceManifest;
• pub use manifest::WorkspaceManifestFile;

Modules

• lock
• manifest

Structs

• BuildOpts
  The set of options provided to the build functions.
• BuildPlan
  Represents the full build plan for a project.
• BuiltPackage
  The result of successfully compiling a package.
• BuiltPackageDescriptor
  The package descriptors that a BuiltPackage holds so that the source used for building the package can be retrieved later on.
• Edge
• GitSourceIndex
  Everything needed to recognize a checkout in offline mode
• MemberFilter
  The set of options to filter type of projects to build in a workspace.
• MinifyOpts
• Pinned
  A package uniquely identified by name along with its pinned source.
• PinnedId
  A unique ID for a pinned package.
• PinnedIdParseError
  Error returned upon failed parsing of PinnedId::from_str.
• Pkg
  A package uniquely identified by name along with its source.
• PkgEntry
  Represents a package entry point.
• PkgOpts
• PkgTestEntry
  Data specific to the test entry point.
• PrintOpts
• Programs
  Contains the lexed, parsed, and typed compilation stages of a program.
• SourceGit
  A git repo with a Forc.toml manifest at its root.
• SourceGitPinned
  A pinned instance of a git source.
• SourcePathPinned
  A pinned instance of a path source.
• SourcePathPinnedParseError
  Error returned upon failed parsing of SourcePathPinned::from_str.
• SourcePinnedParseError
  Error returned upon failed parsing of SourcePinned::from_str.
• SourceRegistry
  A package from the official registry.
• SourceRegistryPinned
  A pinned instance of the registry source.

Enums

• Built
• DepKind
• GitReference
  Used to distinguish between types of git references.
• PkgEntryKind
  Data specific to each kind of package entry point.
• 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.
• TestPassCondition
  The possible conditions for a test result to be considered “passing”.

Constants

• CONTRACT_ID_CONSTANT_NAME
  The name of the constant holding the contract’s id.
• SWAY_BIN_HASH_SUFFIX
  The suffix that helps identify the file which contains the hash of the binary file created when scripts are built_package.
• SWAY_BIN_ROOT_SUFFIX
  The suffix that helps identify the file which contains the root hash of the binary file created when predicates are built_package.

Functions

• build
  Build an entire forc package and return the built_package output.
• build_with_options
  Builds a project with given BuildOptions.
• check
  Compile the entire forc package and return the lexed, parsed and typed programs of the dependancies and project. The final item in the returned vector is the project.
• 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.
• compile_ast
  Compiles the package to an AST.
• contract_id
  Returns the ContractId of a built_package contract with specified salt.
• 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.
• manifest_file_missing
  Format an error message for an absent Forc.toml.
• parse
  Returns a parsed AST from the supplied PackageManifestFile
• 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::BuildProfile, 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

• BuiltWorkspace
  The result of successfully compiling a workspace.
• DependencyName
  The name specified on the left hand side of the = in a depenedency declaration under [dependencies] within a forc manifest.
• EdgeIx
• Graph
• ManifestMap
• NodeIx