Struct forc_client::ops::deploy::cmd::DeployCommand

pub struct DeployCommand {

    pub path: Option<String>,
    pub print_ast: bool,
    pub print_finalized_asm: bool,
    pub print_intermediate_asm: bool,
    pub print_ir: bool,
    pub binary_outfile: Option<String>,
    pub debug_outfile: Option<String>,
    pub offline_mode: bool,
    pub terse_mode: bool,
    pub output_directory: Option<String>,
    pub minify_json_abi: bool,
    pub minify_json_storage_slots: bool,
    pub locked: bool,
    pub url: Option<String>,
    pub build_profile: Option<String>,
    pub release: bool,
    pub time_phases: bool,
    pub unsigned: bool,
    pub gas_limit: Option<u64>,
    pub gas_price: Option<u64>,
    pub signing_key: Option<SecretKey>,
}

Fields

path: Option<String>

Path to the project, if not specified, current working directory will be used.

print_ast: bool

Print the generated Sway AST (Abstract Syntax Tree).

print_finalized_asm: bool

Print the finalized ASM.

This is the state of the ASM with registers allocated and optimisations applied.

print_intermediate_asm: bool

Print the generated ASM.

This is the state of the ASM prior to performing register allocation and other ASM optimisations.

print_ir: bool

Print the generated Sway IR (Intermediate Representation).

binary_outfile: Option<String>

If set, outputs a binary file representing the script bytes.

debug_outfile: Option<String>

If set, outputs source file mapping in JSON format

offline_mode: bool

Offline mode, prevents Forc from using the network when managing dependencies. Meaning it will only try to use previously downloaded dependencies.

terse_mode: bool

Terse mode. Limited warning and error output.

output_directory: Option<String>

The directory in which the sway compiler output artifacts are placed.

By default, this is <project-root>/out.

minify_json_abi: bool

By default the JSON for ABIs is formatted for human readability. By using this option JSON output will be “minified”, i.e. all on one line without whitespace.

minify_json_storage_slots: bool

By default the JSON for initial storage slots is formatted for human readability. By using this option JSON output will be “minified”, i.e. all on one line without whitespace.

locked: bool

Requires that the Forc.lock file is up-to-date. If the lock file is missing, or it needs to be updated, Forc will exit with an error

url: Option<String>

The node url to deploy, if not specified uses DEFAULT_NODE_URL. If url is specified overrides network url in manifest file (if there is one).

build_profile: Option<String>

Name of the build profile to use. If it is not specified, forc will use debug build profile.

release: bool

Use release build plan. If a custom release plan is not specified, it is implicitly added to the manifest file.

If –build-profile is also provided, forc omits this flag and uses provided build-profile.

time_phases: bool

Output the time elapsed over each part of the compilation process.

unsigned: bool

Do not sign the transaction

gas_limit: Option<u64>

Set the transaction gas limit. Defaults to the maximum gas limit.

gas_price: Option<u64>

Set the transaction gas price. Defaults to 0.

signing_key: Option<SecretKey>

Set the key to be used for signing.

Trait Implementations

impl Args for DeployCommand

fn augment_args<'b>(__clap_app: Command<'b>) -> Command<'b>

Append to Command so it can instantiate Self.

fn augment_args_for_update<'b>(__clap_app: Command<'b>) -> Command<'b>

Append to Command so it can update self.

impl CommandFactory for DeployCommand

fn into_app<'b>() -> Command<'b>

Deprecated, replaced with CommandFactory::command

fn into_app_for_update<'b>() -> Command<'b>

Deprecated, replaced with CommandFactory::command_for_update

fn command<'help>() -> App<'help>

Build a Command that can instantiate Self.

fn command_for_update<'help>() -> App<'help>

Build a Command that can update self.

impl Debug for DeployCommand

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for DeployCommand

fn default() -> DeployCommand

Returns the “default value” for a type.

impl FromArgMatches for DeployCommand

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn from_arg_matches_mut(
    __clap_arg_matches: &mut ArgMatches
) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn update_from_arg_matches(
    &mut self,
    __clap_arg_matches: &ArgMatches
) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut(
    &mut self,
    __clap_arg_matches: &mut ArgMatches
) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Parser for DeployCommand

fn parse() -> Self

Parse from std::env::args_os(), exit on error

fn try_parse() -> Result<Self, Error>

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Selfwhere
    I: IntoIterator<Item = T>,
    T: Into<OsString> + Clone,

Parse from iterator, exit on error

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error>where
    I: IntoIterator<Item = T>,
    T: Into<OsString> + Clone,

Parse from iterator, return Err on error.

fn update_from<I, T>(&mut self, itr: I)where
    I: IntoIterator<Item = T>,
    T: Into<OsString> + Clone,

Update from iterator, exit on error

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error>where
    I: IntoIterator<Item = T>,
    T: Into<OsString> + Clone,

Update from iterator, return Err on error.