Struct forc::cli::RunCommand

source · [−]

pub struct RunCommand {Show 20 fields
    pub data: Option<String>,
    pub path: Option<String>,
    pub use_orig_asm: bool,
    pub dry_run: bool,
    pub node_url: String,
    pub kill_node: 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 silent_mode: bool,
    pub pretty_print: bool,
    pub contract: Option<Vec<String>>,
    pub output_directory: Option<String>,
    pub minify_json_abi: bool,
    pub byte_price: Option<u64>,
    pub gas_limit: Option<u64>,
    pub gas_price: Option<u64>,
    pub locked: bool,
}

Expand description

Run script project. Crafts a script transaction then sends it to a running node.

Fields

data: Option<String>

Hex string of data to input to script.

path: Option<String>

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

use_orig_asm: bool

Whether to compile using the original (pre- IR) pipeline.

dry_run: bool

Only craft transaction and print it out.

node_url: String

URL of the Fuel Client Node

kill_node: bool

Kill Fuel Node Client after running the code. This is only available if the node is started from forc run

print_finalized_asm: bool

Whether to compile to bytecode (false) or to print out the generated ASM (true).

print_intermediate_asm: bool

Whether to compile to bytecode (false) or to print out the generated ASM (true).

print_ir: bool

Whether to compile to bytecode (false) or to print out the IR (true).

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

silent_mode: bool

Silent mode. Don’t output any warnings or errors to the command line.

pretty_print: bool

Pretty-print the outputs from the node.

contract: Option<Vec<String>>

32-byte contract ID that will be called during the transaction.

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.

byte_price: Option<u64>

Set the transaction byte price. Defaults to 0.

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.

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

Trait Implementations

impl Args for Command

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

Append to Command so it can instantiate Self. Read more

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

Append to Command so it can update self. Read more

impl CommandFactory for Command

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

👎 Deprecated since 3.1.0:

Replaced with `CommandFactory::command

Deprecated, replaced with CommandFactory::command

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

👎 Deprecated since 3.1.0:

Replaced with `CommandFactory::command_for_update

Deprecated, replaced with CommandFactory::command_for_update

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

Build a Command that can instantiate Self. Read more

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

Build a Command that can update self. Read more

impl Debug for Command

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

Formats the value using the given formatter. Read more

impl Default for Command

fn default() -> Command

Returns the “default value” for a type. Read more

impl FromArgMatches for Command

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

Instantiate Self from ArgMatches, parsing the arguments as needed. Read more

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

Assign values from ArgMatches to self.

impl Parser for Command

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) -> Self where
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.

Auto Trait Implementations

impl RefUnwindSafe for Command

impl Send for Command

impl Sync for Command

impl Unpin for Command

impl UnwindSafe for Command

Blanket Implementations

impl<T> Any for T where
T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T, U> FlattenInto<U> for T where
U: FlattenFrom<T>,

fn flatten_into(self) -> U

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

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

fn in_current_span(self) -> Instrumented<Self>

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

impl<T, U> Into<U> for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

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

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<T, U> TryFrom<U> for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more