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,
}
Expand description
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
sourceimpl CommandFactory for RocflArgs
impl CommandFactory for RocflArgs
sourcefn into_app<'b>() -> Command<'b>
fn into_app<'b>() -> Command<'b>
Replaced with `CommandFactory::command
Deprecated, replaced with CommandFactory::command
sourcefn into_app_for_update<'b>() -> Command<'b>
fn into_app_for_update<'b>() -> Command<'b>
Replaced with `CommandFactory::command_for_update
Deprecated, replaced with CommandFactory::command_for_update
sourcefn command_for_update<'help>() -> App<'help>
fn command_for_update<'help>() -> App<'help>
sourceimpl FromArgMatches for RocflArgs
impl FromArgMatches for RocflArgs
sourcefn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>
fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>
Instantiate Self
from ArgMatches
, parsing the arguments as needed. Read more
sourcefn update_from_arg_matches(
&mut self,
__clap_arg_matches: &ArgMatches
) -> Result<(), Error>
fn update_from_arg_matches(
&mut self,
__clap_arg_matches: &ArgMatches
) -> Result<(), Error>
Assign values from ArgMatches
to self
.
sourceimpl Parser for RocflArgs
impl Parser for RocflArgs
sourcefn parse_from<I, T>(itr: I) -> Self where
I: IntoIterator<Item = T>,
T: Into<OsString> + Clone,
fn parse_from<I, T>(itr: I) -> Self where
I: IntoIterator<Item = T>,
T: Into<OsString> + Clone,
Parse from iterator, exit on error
sourcefn try_parse_from<I, T>(itr: I) -> Result<Self, Error> where
I: IntoIterator<Item = T>,
T: Into<OsString> + Clone,
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.
sourcefn update_from<I, T>(&mut self, itr: I) where
I: IntoIterator<Item = T>,
T: Into<OsString> + Clone,
fn update_from<I, T>(&mut self, itr: I) where
I: IntoIterator<Item = T>,
T: Into<OsString> + Clone,
Update from iterator, exit on error
sourcefn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error> where
I: IntoIterator<Item = T>,
T: Into<OsString> + Clone,
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 RocflArgs
impl Send for RocflArgs
impl Sync for RocflArgs
impl Unpin for RocflArgs
impl UnwindSafe for RocflArgs
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
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
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more