Struct iroh_blobs::cli::BlobAddOptions

pub struct BlobAddOptions {
    pub in_place: bool,
    pub tag: Option<String>,
    pub wrap: bool,
    pub filename: Option<String>,
    pub no_ticket: bool,
}

Available on crate feature cli only.

Options for the blob add command.

Fields

in_place: bool

Add in place

Set this to true only if you are sure that the data in its current location will not change.

tag: Option<String>

Tag to tag the data with.

wrap: bool

Wrap the added file or directory in a collection.

When adding a single file, without wrap the file is added as a single blob and no collection is created. When enabling wrap it also creates a collection with a single entry, where the entry’s name is the filename and the entry’s content is blob.

When adding a directory, a collection is always created. Without wrap, the collection directly contains the entries from the added directory. With wrap, the directory will be nested so that all names in the collection are prefixed with the directory name, thus preserving the name of the directory.

When adding content from STDIN and setting wrap you also need to set filename to name the entry pointing to the content from STDIN.

filename: Option<String>

Override the filename used for the entry in the created collection.

Only supported wrap is set. Required when adding content from STDIN and setting wrap.

no_ticket: bool

Do not print the all-in-one ticket to get the added data from this node.

Trait Implementations

impl Args for BlobAddOptions

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 BlobAddOptions

fn clone(&self) -> BlobAddOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BlobAddOptions

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

Formats the value using the given formatter.

impl FromArgMatches for BlobAddOptions

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

Assign values from ArgMatches to self.