Struct ArchiveArgs 

pub struct ArchiveArgs {
    pub local: Option<PathBuf>,
    pub s3_bucket: Option<String>,
    pub s3_region: Option<String>,
    pub s3_endpoint: Option<String>,
    pub s3_access_key_id: Option<String>,
    pub s3_secret_access_key: Option<String>,
    pub s3_allow_http: bool,
    pub gcs_bucket: Option<String>,
    pub gcs_service_account_path: Option<String>,
    pub gcs_endpoint: Option<String>,
    pub gcs_allow_http: bool,
    pub prefix: Option<String>,
}

Where the archive is.

Exactly one backend is selected. The sub-flags of a backend are checked by ArchiveArgs::validate, not by clap: a mutually exclusive ArgGroup makes clap’s requires unenforceable, because clap treats a required argument as acceptably absent when it conflicts with one that is present.

The fields are public so a test or an embedding tool can build the struct directly rather than through an argv.

Fields

local: Option<PathBuf>

Use a local directory tree as the archive.

s3_bucket: Option<String>

Use this S3 or S3-compatible bucket as the archive.

s3_region: Option<String>

S3 region. Defaults to us-east-1, which MinIO and R2 accept as a placeholder.

s3_endpoint: Option<String>

S3 endpoint URL, for a non-AWS S3-compatible store.

s3_access_key_id: Option<String>

S3 access key id. Without it the AWS credential chain applies.

s3_secret_access_key: Option<String>

S3 secret access key. Without it the AWS credential chain applies.

s3_allow_http: bool

Allow plaintext HTTP to the S3 endpoint.

gcs_bucket: Option<String>

Use this Google Cloud Storage bucket as the archive.

gcs_service_account_path: Option<String>

Path to a GCS service-account JSON key. Without it Workload Identity or application default credentials apply.

gcs_endpoint: Option<String>

GCS API base URL, for an emulator.

gcs_allow_http: bool

Allow plaintext HTTP to the GCS endpoint.

prefix: Option<String>

Key prefix inside the archive, for a bucket that holds more than the tiered-storage tree. It applies to every backend.

Implementations

impl ArchiveArgs

pub fn validate(&self) -> Result<(), ArchiveArgsError>

Reject a sub-flag whose backend was not selected.

Errors

Returns [ArchiveArgsError::OrphanFlag] naming the first such flag and the backend flag it needs.

pub fn to_config(&self) -> Result<ObjectStoreConfig, ArchiveArgsError>

Map the flags onto an object-store configuration.

The prefix is not set here. It stays with the caller’s archive handle, so the same handle can address a key inside the archive and list the archive root; see [normalize_prefix] and [prefixed_key].

Errors

Returns [ArchiveArgsError::NoBackend] when no backend was selected.

pub fn normalized_prefix(&self) -> Option<String>

--archive-prefix, through [normalize_prefix].

Trait Implementations

impl Args for ArchiveArgs

fn group_id() -> Option<Id>

Report the [ArgGroup::id][crate::ArgGroup::id] for this set of arguments

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

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

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

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

impl Clone for ArchiveArgs

fn clone(&self) -> ArchiveArgs

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ArchiveArgs

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

Formats the value using the given formatter.

impl Default for ArchiveArgs

fn default() -> ArchiveArgs

Returns the “default value” for a type.

impl Eq for ArchiveArgs

impl FromArgMatches for ArchiveArgs

fn from_arg_matches( __clap_arg_matches: &ArgMatches, ) -> Result<ArchiveArgs, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<ArchiveArgs, 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( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl PartialEq for ArchiveArgs

fn eq(&self, other: &ArchiveArgs) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for ArchiveArgs