Docs.rs
  • assemble-core-0.2.0
    • assemble-core 0.2.0
    • Permalink
    • Docs.rs crate page
    • MIT OR Apache-2.0
    • Links
    • Homepage
    • Repository
    • crates.io
    • Source
    • Owners
    • joshradin
    • Dependencies
      • assemble-macros ^0.2.0 normal optional
      • atty ^0.2.14 normal
      • clap ^4.0.4 normal
      • colored ^2.0.0 normal
      • crossbeam ^0.8.1 normal
      • dirs ^4.0.0 normal
      • fern ^0.6.1 normal
      • generic-array ^0.14.6 normal
      • glob ^0.3.0 normal
      • heck ^0.4.0 normal
      • indicatif ^0.17.0 normal
      • itertools ^0.10.3 normal
      • log ^0.4.17 normal
      • merge ^0.1.0 normal
      • once_cell ^1.12.0 normal
      • parking_lot ^0.12.1 normal
      • petgraph ^0.6.0 normal
      • ptree ^0.4.0 normal
      • rand ^0.8.5 normal
      • regex ^1.5.6 normal
      • reqwest ^0.11.10 normal
      • rmp-serde ^1.1.1 normal optional
      • ron ^0.8.0 normal optional
      • semver ^1.0.13 normal
      • serde ^1.0.137 normal
      • serde_json ^1.0.82 normal
      • sha2 ^0.10.2 normal
      • static_assertions ^1.1.0 normal
      • strsim ^0.10.0 normal
      • strum ^0.24.1 normal
      • strum_macros ^0.24.1 normal
      • tempfile ^3.3.0 normal
      • thiserror ^1.0.30 normal
      • thread_local ^1.1.4 normal
      • time ^0.3.9 normal
      • toml_edit ^0.16.0 normal
      • url ^2.2.2 normal
      • uuid ^1.1.2 normal
      • walkdir ^2.3.2 normal
      • more_collection_macros ^0.2.2 dev
      • semver ^1.0.13 dev
      • serde_yaml ^0.9.16 dev
      • toml ^0.5.10 dev
    • Versions
    • 55.87% of the crate is documented
  • Platform
    • i686-pc-windows-msvc
    • x86_64-apple-darwin
    • x86_64-pc-windows-msvc
    • x86_64-unknown-linux-gnu
  • Feature flags
  • docs.rs
    • About docs.rs
    • Badges
    • Builds
    • Metadata
    • Shorthand URLs
    • Download
    • Rustdoc JSON
    • Build queue
    • Privacy policy
  • Rust
    • Rust website
    • The Book
    • Standard Library API Reference
    • Rust by Example
    • The Cargo Guide
    • Clippy Documentation

Crate assemble_core

assemble_core0.2.0

  • All Items

Sections

  • assemble-core

Crate Items

  • Re-exports
  • Modules
  • Macros
  • Functions

Crates

  • assemble_core

Crate assemble_core

Source
Expand description

§assemble-core

The api defines the structs, functions, and traits that make up the assemble project.

Re-exports§

pub use exception::BuildResult;
pub use plugins::Plugin;
pub use project::Project;
pub use task::Executable;
pub use task::Task;
pub use workspace::default_workspaces::ASSEMBLE_HOME;
pub use workspace::Workspace;

Modules§

cache
The cache used assemble wise. This is accessible from every project, and should be used with care
cargo
Provides a wrapper around cargo environment variables set during compilation.
cryptography
Cryptography functionality to aid with hashing and comparison
defaults
dependencies
Describe mechanisms to enable projects to have dependencies
error
An error with a payload
exception
Build time exceptions
file
file_collection
fingerprint
Provides ways to “fingerprint” something
flow
Control the in and out flow of a project
identifier
Identifiers are used by lazy_evaluation, tasks, and projects.
immutable
Mark a type as immutable.
lazy_evaluation
Lazy evaluation allows for a more simple approach to sharing data between tasks.
logging
Defines different parts of the logging utilities for assemble-daemon
named
plugins
Provide a “unified” way of adding plugins to an assemble project
prelude
Provides many useful, often use types and functions within assemble
project
resources
startup
The startup part of assemble.
task
utilities
version
Provide version information about assemble, generated at compile time.
web
Control web requests
work_queue
The work queue allows for submission and completion of work.
workflow
workspace
Workspaces help provide limited access to files

Macros§

named_attribute
payload_from
provider
create a provider with a function

Functions§

execute_assemble
Executes some function. If an error is returned by the function, then None is returned and the error is printed to the error output. Otherwise, Some(R) is returned.

Results

Settings
Help
    trait method
    assemble_core::workspace::WorkspaceDirectory::file
    Creates a file within this directory
    method
    assemble_core::file::RegularFile::file
    Get the underlying file of this regular file
    method
    assemble_core::flow::shared::Artifact::file
    Gets the file for this artifact.
    method
    assemble_core::project::Project::file
    Create files using some valid types
    module
    assemble_core::file
    method
    assemble_core::flow::shared::ConfigurableArtifact::file
    method
    assemble_core::flow::shared::ImmutableArtifact::file
    method
    assemble_core::workspace::Dir::file
    method
    assemble_core::workspace::Workspace::file
    trait method
    assemble_core::file_collection::FileCollection::files
    Gets the files contained by this collection.
    method
    assemble_core::dependencies::configurations::ResolvedConfiguration::files
    method
    assemble_core::file_collection::FileSet::files
    method
    assemble_core::file_collection::Component::files
    struct
    assemble_core::file_collection::FileSet
    assoc type
    assemble_core::file::AsFileLocation::FilePath
    Some type that can be interpreted as a path
    trait
    assemble_core::file_collection::FileFilter
    struct
    assemble_core::dependencies::file_dependency::FileSystem
    struct
    assemble_core::file_collection::FileIterator
    An iterator over file components.
    trait method
    assemble_core::file::AsFileLocation::file_location
    Get the file location of this value
    method
    assemble_core::cache::AssembleCache::file_location
    method
    assemble_core::file::RegularFile::file_location
    trait
    assemble_core::file_collection::FileCollection
    A file set is a collection of files. File collections are …
    module
    assemble_core::file_collection
    module
    assemble_core::dependencies::file_dependency
    static
    assemble_core::dependencies::file_dependency::FILE_SYSTEM_TYPE
    The file system dependency type. Just represents a normal
    trait
    assemble_core::file::AsFileLocation
    Trait to get this value as a file location
    method
    assemble_core::flow::shared::ConfigurableArtifact::set_file
    Set the file of the artifact
    method
    assemble_core::file_collection::FileCollection::try_files
    Gets the files contained by this collection. Is fallible.
    method
    assemble_core::file_collection::FileSet::try_files
    method
    assemble_core::file_collection::Component::try_files
    function
    assemble_core::cryptography::hash_file_sha256
    Convenience method for hashing a file into a Sha256 value
    struct
    assemble_core::task::work_handler::InputFile
    An input file is used to serialize a path
    method
    assemble_core::startup::initialization::ProjectDescriptor::build_file
    Gets the build file associated with this project, if known
    struct
    assemble_core::task::work_handler::InputFiles
    Used to serialize a fileset
    enum variant
    assemble_core::workspace::WorkspaceError::EmptyFileName
    method
    assemble_core::workspace::Workspace::create_file
    enum variant
    assemble_core::dependencies::AcquisitionError::MissingFile
    struct
    assemble_core::file::RegularFile
    A wrapper type that derefs to a File, while also providing …
    enum variant
    assemble_core::project::error::ProjectError::InvalidFileType
    method
    assemble_core::project::error::ProjectError::invalid_file_type
    method
    assemble_core::startup::initialization::Settings::settings_file
    method
    assemble_core::task::work_handler::WorkHandler::add_input_file
    method
    assemble_core::dependencies::ResolvedDependency::artifact_files
    Gets the files that are associated with this resolved …
    method
    assemble_core::task::work_handler::WorkHandler::add_input_files
    method
    assemble_core::startup::initialization::Settings::set_build_file_name
    trait method
    assemble_core::workspace::WorkspaceDirectory::protected_file
    Creates a protected file in this directory
    method
    assemble_core::workspace::Dir::protected_file
    method
    assemble_core::workspace::Workspace::protected_file
    method
    assemble_core::startup::initialization::ProjectGraph::set_default_build_file_name
No results :(
Try on DuckDuckGo?

Or try looking in one of these:
  • The Rust Reference for technical details about the language.
  • Rust By Example for expository code examples.
  • The Rust Book for introductions to language features and the language itself.
  • Docs.rs for documentation of crates released on crates.io.
    method
    assemble_core::file::RegularFile::file
    &RegularFile -> &File
    Get the underlying file of this regular file