Docs.rs
  • assemble-std-0.2.0
    • assemble-std 0.2.0
    • Permalink
    • Docs.rs crate page
    • MIT OR Apache-2.0
    • Links
    • Homepage
    • Repository
    • crates.io
    • Source
    • Owners
    • joshradin
    • Dependencies
      • assemble-core ^0.2.0 normal
      • colored ^2.0.0 normal
      • dirs ^4.0.0 normal
      • log ^0.4.17 normal
      • once_cell ^1.13.1 normal
      • reqwest ^0.11.11 normal
      • serde ^1.0.143 normal
      • tempfile ^3.3.0 normal
      • thiserror ^1.0.31 normal
      • url ^2.2.2 normal
      • assemble-build ^0.2.0 build
    • Versions
    • 100% 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_std

assemble_std0.2.0

  • All Items

Sections

  • The Assemble Standard Library

Crate Items

  • Re-exports
  • Modules
  • Macros
  • Structs
  • Statics
  • Traits
  • Functions
  • Type Aliases
  • Attribute Macros
  • Derive Macros

Crates

  • assemble_std

Crate assemble_std

Source
Expand description

§The Assemble Standard Library

Contains extra stuff for assemble-daemon-rs that don’t need to be in the core crate, but provide good content.

Re-exports§

pub use crate::extensions::project_extensions::ProjectExec;
pub use crate::tasks::exec::Exec;
pub use crate::tasks::files::Delete;
pub use crate::tasks::files::Dupe;

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
Additional dependency types
error
An error with a payload
exception
Build time exceptions
extensions
Extensions to various parts of the assemble-daemon-core
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
specs
The standard specs that are used by the standard library
startup
The startup part of assemble.
task
tasks
The standard library tasks. Defines important tasks like Exec and Dupe
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

Structs§

Empty
A task that has no actions by default.
Executable
The wrapped task itself
Plugin
The default plugin for the std library. Is a no-op.
Project
The Project contains the tasks, layout information, and other related objects that would help with project building.
Workspace

Statics§

ASSEMBLE_HOME
Provides access to the instance of the Assemble home workspace

Traits§

Task

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.

Type Aliases§

BuildResult

Attribute Macros§

plug

Derive Macros§

CreateTask
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

Results

Settings
Help
    trait method
    assemble_std::workspace::WorkspaceDirectory::file
    Creates a file within this directory
    method
    assemble_std::Project::file
    Create files using some valid types
    method
    assemble_std::file::RegularFile::file
    Get the underlying file of this regular file
    method
    assemble_std::flow::shared::Artifact::file
    Gets the file for this artifact.
    enum variant
    assemble_std::specs::exec_spec::Input::File
    Get input bytes from a file
    enum variant
    assemble_std::specs::exec_spec::Output::File
    Stream the output into a file
    module
    assemble_std::file
    method
    assemble_std::Workspace::file
    method
    assemble_std::flow::shared::ConfigurableArtifact::file
    method
    assemble_std::flow::shared::ImmutableArtifact::file
    method
    assemble_std::workspace::Dir::file
    module
    assemble_std::tasks::files
    Tasks that are related to files (copying, deleting, etc…)
    trait method
    assemble_std::file_collection::FileCollection::files
    Gets the files contained by this collection.
    method
    assemble_std::file_collection::FileSet::files
    method
    assemble_std::file_collection::Component::files
    method
    assemble_std::prelude::dependencies::configurations::ResolvedConfiguration::files
    struct
    assemble_std::file_collection::FileSet
    assoc type
    assemble_std::file::AsFileLocation::FilePath
    Some type that can be interpreted as a path
    method
    assemble_std::dependencies::web::WebDependency::file_name
    Gets the file name.
    trait
    assemble_std::file_collection::FileFilter
    struct
    assemble_std::prelude::dependencies::file_dependency::FileSystem
    struct
    assemble_std::file_collection::FileIterator
    An iterator over file components.
    trait method
    assemble_std::file::AsFileLocation::file_location
    Get the file location of this value
    method
    assemble_std::cache::AssembleCache::file_location
    method
    assemble_std::file::RegularFile::file_location
    trait
    assemble_std::file_collection::FileCollection
    A file set is a collection of files. File collections are …
    module
    assemble_std::file_collection
    module
    assemble_std::prelude::dependencies::file_dependency
    static
    assemble_std::prelude::dependencies::file_dependency::FILE_SYSTEM_TYPE
    The file system dependency type. Just represents a normal
    trait
    assemble_std::file::AsFileLocation
    Trait to get this value as a file location
    method
    assemble_std::flow::shared::ConfigurableArtifact::set_file
    Set the file of the artifact
    method
    assemble_std::file_collection::FileCollection::try_files
    Gets the files contained by this collection. Is fallible.
    method
    assemble_std::file_collection::FileSet::try_files
    method
    assemble_std::file_collection::Component::try_files
    method
    assemble_std::dependencies::web::WebDependency::with_file_name
    Set an alternate file name to use.
    function
    assemble_std::cryptography::hash_file_sha256
    Convenience method for hashing a file into a Sha256 value
    struct
    assemble_std::task::work_handler::InputFile
    An input file is used to serialize a path
    method
    assemble_std::prelude::ProjectDescriptor::build_file
    Gets the build file associated with this project, if known
    struct
    assemble_std::task::work_handler::InputFiles
    Used to serialize a fileset
    enum variant
    assemble_std::workspace::WorkspaceError::EmptyFileName
    method
    assemble_std::Workspace::create_file
    function
    assemble_std::dependencies::web::remote_file_system_type
    Create a remote file system dependency type for a given …
    enum variant
    assemble_std::prelude::dependencies::AcquisitionError::MissingFile
    struct
    assemble_std::file::RegularFile
    A wrapper type that derefs to a File, while also providing …
    enum variant
    assemble_std::project::ProjectError::InvalidFileType
    method
    assemble_std::project::ProjectError::invalid_file_type
    struct
    assemble_std::tasks::web::DownloadFile
    Downloads a file
    method
    assemble_std::prelude::Settings::settings_file
    method
    assemble_std::task::work_handler::WorkHandler::add_input_file
    method
    assemble_std::prelude::dependencies::ResolvedDependency::artifact_files
    Gets the files that are associated with this resolved …
    method
    assemble_std::task::work_handler::WorkHandler::add_input_files
    method
    assemble_std::prelude::Settings::set_build_file_name
    trait method
    assemble_std::workspace::WorkspaceDirectory::protected_file
    Creates a protected file in this directory
    method
    assemble_std::Workspace::protected_file
    method
    assemble_std::workspace::Dir::protected_file
    method
    assemble_std::prelude::ProjectGraph::set_default_build_file_name
    method
    assemble_std::prelude::text_factory::list::fmt::Formatter::fill
    Returns the character used as ‘fill’ whenever there is …
    method
    assemble_std::prelude::text_factory::list::fmt::FormattingOptions::fill
    Sets the fill character.
    struct field
    assemble_std::specs::exec_spec::Output::File::path
    File -> PathBuf
    The path of the file to emit output to
    struct field
    assemble_std::specs::exec_spec::Output::File::append
    File -> bool
    whether to append to the file or not
    method
    assemble_std::file::RegularFile::file
    &RegularFile -> &File
    Get the underlying file of this regular file
    method
    assemble_std::lazy_evaluation::Prop::read
    &Prop<P> -> StdResult<File, PayloadError<ProjectError>>
    Attempt to read a file
    method
    assemble_std::lazy_evaluation::Prop::create
    &Prop<P> -> StdResult<File, PayloadError<ProjectError>>
    Attempt to read a file
    method
    assemble_std::lazy_evaluation::Prop::open
    &Prop<P>, &OpenOptions -> StdResult<File, PayloadError<ProjectError>>
    Attempt to open the file using given open_options