Enum OrbCommand 

pub enum OrbCommand {
    Key {
        command: KeyCommand,
    },
    Sphere {
        command: SphereCommand,
    },
    Version {
        verbose: bool,
    },
    Serve {
        cors_origin: Option<Url>,
        ipfs_api: Url,
        name_resolver_api: Url,
        interface: IpAddr,
        port: u16,
        storage_memory_cache_limit: Option<usize>,
    },
}

Variants

Key

Fields

command: KeyCommand

Sphere

Fields

command: SphereCommand

Version

Display version information for this build of the CLI

Fields

verbose: bool

Display extra build and git metadata

Serve

Summon a gateway geist to manage the local sphere; it will accept push, fetch and other REST actions from any clients that are authorized to operate on its counterpart sphere. When it receives changes to its counterpart sphere, it will perform various actions such as publishing and/or querying the Noosphere Name System, generating static HTML and/or updating its own sphere with various related information of interest to the counterpart sphere

Fields

cors_origin: Option<Url>

Optional origin to allow CORS for

ipfs_api: Url

URL of a Kubo Gateway RPC API

name_resolver_api: Url

URL for a Noosphere name system RPC API

interface: IpAddr

The IP address of the interface that the gateway should bind to

port: u16

The port that the gateway should listen on

storage_memory_cache_limit: Option<usize>

If set, the amount of memory that the storage provider may use for caching in bytes.

Trait Implementations

impl Debug for OrbCommand

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

Formats the value using the given formatter.

impl FromArgMatches for OrbCommand

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 Subcommand for OrbCommand

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

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut

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

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut

fn has_subcommand(__clap_name: &str) -> bool

Test whether Self can parse a specific subcommand