Enum holochain_cli_bundle::HcAppBundle

pub enum HcAppBundle {
    Init {
        path: PathBuf,
    },
    Pack {
        path: PathBuf,
        output: Option<PathBuf>,
    },
    Unpack {
        path: PathBuf,
        output: Option<PathBuf>,
        force: bool,
    },
}

Work with Holochain hApp bundles

Variants

Init

Fields

path: PathBuf

The path to create the working directory

Create a new, empty Holochain app (hApp) working directory and create a new sample happ.yaml manifest inside.

Pack

Fields

path: PathBuf

The path to the working directory containing a happ.yaml manifest

output: Option<PathBuf>

Specify the output path for the packed bundle file

If not specified, the [name].happ bundle will be placed inside the provided working directory.

Pack into the [name].happ bundle according to the happ.yaml manifest, found inside the working directory. The [name] is taken from the name property of the manifest file.

e.g.:

$ hc app pack ./some/directory/foo

creates a file ./some/directory/foo/[name].happ, based on ./some/directory/foo/happ.yaml

Unpack

Fields

path: PathBuf

The path to the bundle to unpack

output: Option<PathBuf>

Specify the directory for the unpacked content

If not specified, the directory will be placed alongside the bundle file, with the same name as the bundle file name.

force: bool

Overwrite an existing directory, if one exists

Unpack parts of the .happ bundle file into a specific directory.

e.g.:

$ hc app unpack ./some/dir/my-app.happ

creates a new directory ./some/dir/my-app, containining a new happ.yaml manifest

Implementations

impl HcAppBundle

pub async fn run(self) -> Result<()>

Run this command

Trait Implementations

impl Debug for HcAppBundle

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

Formats the value using the given formatter.

impl StructOpt for HcAppBundle

fn clap<'a, 'b>() -> App<'a, 'b>

Returns clap::App corresponding to the struct.

fn from_clap(matches: &ArgMatches<'_>) -> Self

Builds the struct from clap::ArgMatches. It’s guaranteed to succeed if matches originates from an App generated by StructOpt::clap called on the same type, otherwise it must panic.

fn from_args() -> Self

Builds the struct from the command line arguments (std::env::args_os). Calls clap::Error::exit on failure, printing the error message and aborting the program.

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

Builds the struct from the command line arguments (std::env::args_os). Unlike StructOpt::from_args, returns clap::Error on failure instead of aborting the program, so calling .exit is up to you.

fn from_iter<I>(iter: I) -> Self where
    I: IntoIterator,
    <I as IntoIterator>::Item: Into<OsString>,
    <I as IntoIterator>::Item: Clone, 

Gets the struct from any iterator such as a Vec of your making. Print the error message and quit the program in case of failure.

fn from_iter_safe<I>(iter: I) -> Result<Self, Error> where
    I: IntoIterator,
    <I as IntoIterator>::Item: Into<OsString>,
    <I as IntoIterator>::Item: Clone, 

Gets the struct from any iterator such as a Vec of your making.