Expand description
Provides many useful, often use types and functions within assemble
Modules§
- dependencies
- Describe mechanisms to enable projects to have dependencies
- text_
factory - Text factory adds some useful traits and factories for producing text.
Macros§
- named_
attribute - payload_
from - provider
- create a provider with a function
Structs§
- Assemble
- Provides a wrapper around the assemble instance that’s running this build.
- Executable
- The wrapped task itself
- Plugin
Manager - Facilities applying plugins and determining which plugins have been applied to a plugin aware object.
- Project
- The Project contains the tasks, layout information, and other related objects that would help with project building.
- Project
Builder - Helps to build a project
- Project
Descriptor - A project descriptor is used to define projects.
- Project
Graph - Describes the project graph
- Project
Id - How projects are referenced. Unlike tasks, projects don’t have to have parents.
- Settings
- Declares the configuration required to instantiate and configure the hierarchy of
SharedProjectwhich are part of this build. There’s exactly one settings instance that’s created per settings file. - Shared
Project - The shared project allows for many projects to share references to the same
Projectinstance. - Start
Parameter - The start parameters define the configuration used by an assemble instance to execute a build.
- TaskId
- How tasks are referenced throughout projects.
- Workspace
Enums§
- Backtrace
Emit - The mechanism to emit the backtrace at
- Project
Error - StdResult
Resultis a type that represents either success (Ok) or failure (Err).
Statics§
- ASSEMBLE_
HOME - Provides access to the instance of the Assemble home workspace
Traits§
- Assemble
Aware - A type that’s aware it’s part of an assemble build
- Create
Project - Trait for creating a project
- Plugin
- A plugin to apply to the project. All plugins must implement default.
- Plugin
Aware - Some value that can have plugins applied to it.
- Provider
- The provider trait represents an object that can continuously produce a value. Provider values
can be chained together using the
ProviderExttrait. - Provider
Ext - Provides extensions that are not object safe to the Provider trait.
- Settings
Aware - A type that’s aware of the settings value
- Task
Functions§
- execute_
assemble - Executes some function. If an error is returned by the function, then
Noneis returned and the error is printed to the error output. Otherwise,Some(R)is returned.
Type Aliases§
- Build
Result - Project
Result - Result
- A result with a pay-loaded error
Attribute Macros§
Derive Macros§
- Create
Task - Creates tasks using default values. Also creates lazy_evaluation using the name of the field
- TaskIO
- Enables shortcuts for adding inputs and outputs for tasks