Struct rocfl::cmd::opts::RocflArgs

pub struct RocflArgs {
    pub name: Option<String>,
    pub root: Option<String>,
    pub staging_root: Option<String>,
    pub region: Option<String>,
    pub bucket: Option<String>,
    pub endpoint: Option<String>,
    pub profile: Option<String>,
    pub quiet: bool,
    pub verbose: bool,
    pub no_styles: bool,
    pub command: Command,
}

A CLI for OCFL repositories

rocfl provides a variety of subcommands for interacting with OCFL repositories on the local filesystem or in S3. Its goal is to provide a logical view of OCFL objects and make them easy to interact with in a unix-like way.

rocfl is able to interact with repositories without a defined storage layout, but this does come at a significant performance cost. Defining your OCFL storage layout is strongly recommended.

Each subcommand has its own help page that provides details about how to use the command. There are a number of global options that apply to most, if not all, subcommands that are described here. A number of these options, such as repository location information, can be defined in a configuration file so that they do not needed to be specified on every invocation. The easiest way to do this is by invoking: ‘rocfl config’.

Fields

name: Option<String>

Name of the repository to access

Repository names are used to load repository specific configuration in the rocfl config file. For example, a repository’s root could be defined in the config and referenced here by name so that the root does not need to be specified with every command.

root: Option<String>

Absolute or relative path to the repository’s storage root

By default, this is the current directory.

staging_root: Option<String>

Absolute or relative path to the staging directory

By default, versions are staged in an extensions directory in the main repository. This is the recommended configuration. If the repository is in S3, then versions are staged in an OS specific user home directory. Staging directories should NOT be shared by multiple different repositories.

region: Option<String>

AWS region identifier. Must specify when using S3.

bucket: Option<String>

S3 bucket name. Must specify when using S3.

endpoint: Option<String>

Custom S3 endpoint URL. Only specify when using a custom region.

profile: Option<String>

AWS profile to load credentials from.

quiet: bool

Suppress error messages and other command specific logging

verbose: bool

Increase log level

no_styles: bool

Disable all output styling

command: Command

Subcommand to execute

Trait Implementations

impl Args for RocflArgs

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 RocflArgs

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 an Command that can instantiate Self.

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

Build an Command that can update self.

impl Debug for RocflArgs

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

Formats the value using the given formatter.

impl FromArgMatches for RocflArgs

fn from_arg_matches(__clap_arg_matches: &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.

impl Parser for RocflArgs

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.