Struct cubist_config::Config

source ·
pub struct Config {
    pub config_path: PathBuf,
    pub type_: ProjType,
    pub network_profiles: HashMap<NetworkProfileName, NetworkProfile>,
    pub current_network_profile: NetworkProfileName,
    pub bridge_provider: BridgeProvider,
    /* private fields */
}
Expand description

Top-level cubist application configuration.

Configs are consumed by all SDKs.

Fields§

§config_path: PathBuf

Absolute path to the file corresponding to this configuration.

§type_: ProjType

Project type

§network_profiles: HashMap<NetworkProfileName, NetworkProfile>

A map of named network profiles for use in development, testing, etc.

§current_network_profile: NetworkProfileName

Selected network profile. If omitted, defaults to “default”. A network profile with the same name must be defined in network_profiles.

§bridge_provider: BridgeProvider

The bridge provider to use for cross-chain invocations.

Implementations§

Create configuration given type and directory.

Arguments
  • type_ - Project type
  • dir - Project directory
Example
use cubist_config::{Config, ProjType};
use tempfile::tempdir;
use std::fs;

// Create temp dir
let dir = tempdir().unwrap();
fs::create_dir_all(&dir).unwrap();

// Create config (in temp dir)
let cfg: Config = Config::new(ProjType::JavaScript, &dir).unwrap();

assert_eq!(cfg.type_, ProjType::JavaScript);
assert_eq!(cfg.build_dir(), dir.path().join("build"));
assert_eq!(cfg.deploy_dir(), dir.path().join("deploy"));

// Save config file to disk
cfg.to_file(false).unwrap();

// Load config from disk
let cfg2 = Config::from_file(&cfg.config_path).unwrap();

Get well-known paths

Create configuration from config file in the current directory or some parent directory.

Example
use cubist_config::{Config, ProjType};
use tempfile::tempdir;
use std::fs;
use std::env;

// Create temp directory and chdir
let dir = tempdir().unwrap();
fs::create_dir_all(&dir).unwrap();
assert!(env::set_current_dir(&dir).is_ok());

// Create config
let cfg: Config = Config::new(ProjType::JavaScript, ".").unwrap();
cfg.to_file(false).unwrap();

// Load config from disk
let cfg2 = Config::nearest().unwrap();

Create configuration from directory (really from DEFAULT_FILENAME file in the directory).

Create configuration from JSON file. Some paths can be overridden via environment variables:

  • Set deploy_dir via CUBIST_DEPLOY_DIR
  • Set build_dir via CUBIST_BUILD_DIR

This function serves as the deserializer to all the other loaders (namely Self::nearest and Self::from_dir).

Save configuration to new file.

Writing to an existing file is generally discouraged (but can be done with by passing true fo the force argument). When we read configs from file, we resolve some paths (e.g., we turn contract globs into paths) and don’t preserve the original. We also make the build, deploy, and contracts root dir relative to the project root. We do this largely because we use to_file when we create new projects. This does mean: to_file(from_file(_)) is not the identiy function!

Get the top-level project directory

Get the absolute deploy directory

Get the absolute build directory

Return relative path to the project root if the path is inside the project root.

Get contracts configurations.

Return all targets.

Return configured network (if any) for a given target.

Return the currently selected network profile.

Returns true if imports from external sources are allowed.

Returns the compiler configuration for this Cubist configuration.

Trait Implementations§

Returns a copy of the value. Read more
Performs copy-assignment from source. Read more
Formats the value using the given formatter. Read more
Returns the “default value” for a type. Read more
Deserialize this value from the given Serde deserializer. Read more
The name of the generated JSON Schema. Read more
Generates a JSON Schema for this type. Read more
Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword. Read more
Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Gets the TypeId of self. Read more
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Set the foreground color generically Read more
Set the background color generically. Read more
Change the foreground color to black
Change the background color to black
Change the foreground color to red
Change the background color to red
Change the foreground color to green
Change the background color to green
Change the foreground color to yellow
Change the background color to yellow
Change the foreground color to blue
Change the background color to blue
Change the foreground color to magenta
Change the background color to magenta
Change the foreground color to purple
Change the background color to purple
Change the foreground color to cyan
Change the background color to cyan
Change the foreground color to white
Change the background color to white
Change the foreground color to the terminal default
Change the background color to the terminal default
Change the foreground color to bright black
Change the background color to bright black
Change the foreground color to bright red
Change the background color to bright red
Change the foreground color to bright green
Change the background color to bright green
Change the foreground color to bright yellow
Change the background color to bright yellow
Change the foreground color to bright blue
Change the background color to bright blue
Change the foreground color to bright magenta
Change the background color to bright magenta
Change the foreground color to bright purple
Change the background color to bright purple
Change the foreground color to bright cyan
Change the background color to bright cyan
Change the foreground color to bright white
Change the background color to bright white
Make the text bold
Make the text dim
Make the text italicized
Make the text italicized
Make the text blink
Make the text blink (but fast!)
Swap the foreground and background colors
Hide the text
Cross out the text
Set the foreground color at runtime. Only use if you do not know which color will be used at compile-time. If the color is constant, use either OwoColorize::fg or a color-specific method, such as OwoColorize::green, Read more
Set the background color at runtime. Only use if you do not know what color to use at compile-time. If the color is constant, use either OwoColorize::bg or a color-specific method, such as OwoColorize::on_yellow, Read more
Set the foreground color to a specific RGB value.
Set the background color to a specific RGB value.
Sets the foreground color to an RGB value.
Sets the background color to an RGB value.
Apply a runtime-determined style
Should always be Self
The resulting type after obtaining ownership.
Creates owned data from borrowed data, usually by cloning. Read more
Uses borrowed data to replace owned data, usually by cloning. Read more
The type returned in the event of a conversion error.
Performs the conversion.
The type returned in the event of a conversion error.
Performs the conversion.
Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more