Enum Program

pub enum Program {
    Meta {
        meta: PathBuf,
        meta_override: Vec<u8>,
        derive: Option<String>,
    },
    State {
        pid: H256,
        method: Option<String>,
        wasm: Option<Vec<u8>>,
        args: Option<Vec<u8>>,
        at: Option<H256>,
    },
}

Read program state, etc.

Variants

Meta

Display metadata of the program.

More details please check https://wiki.gear-tech.io/docs/api/metadata-type-creation.

Fields

meta: PathBuf

Path of “*.meta.txt” or “*meta.wasm”.

• “*.meta.txt” describes the metadata of the program
• “*.meta.wasm” describes the wasm exports of the program

meta_override: Vec<u8>

Overridden metadata binary if feature embed is enabled.

derive: Option<String>

Derive the description of the specified type from registry.

State

Read program state.

For more details, see https://wiki.gear-tech.io/docs/api/read-state.

Fields

pid: H256

Program id.

method: Option<String>

Method of reading state from wasm (hex encoding).

wasm: Option<Vec<u8>>

The path of “*.meta.wasm”.

args: Option<Vec<u8>>

Method arguments (hex encoding).

at: Option<H256>

The block hash for reading state.

Implementations

impl Program

pub fn clone_with_meta_overridden(&self, meta: Vec<u8>) -> Self

Clone self with metadata overridden.

pub async fn exec(&self, app: &impl App) -> Result<()>

Run command program.

Trait Implementations

impl Clone for Program

fn clone(&self) -> Program

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl CommandFactory for Program

fn command<'b>() -> Command

Build a Command that can instantiate Self.

fn command_for_update<'b>() -> Command

Build a Command that can update self.

impl Debug for Program

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

Formats the value using the given formatter.

impl FromArgMatches for Program

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<'b>( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Parser for Program

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.

impl Subcommand for Program

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

Append to Command so it can instantiate Self.

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

Append to Command so it can update self.

fn has_subcommand(__clap_name: &str) -> bool

Test whether Self can parse a specific subcommand