Struct rocfl::cmd::opts::CommitCmd

pub struct CommitCmd {
    pub pretty_print: bool,
    pub user_name: Option<String>,
    pub user_address: Option<String>,
    pub message: Option<String>,
    pub created: Option<DateTime<Local>>,
    pub object_root: Option<String>,
    pub object_id: String,
}

Commit an object’s staged changes to a new OCFL version.

Creates a new OCFL version for all of the changes that were staged for an object, all files are deduplicated, and installs the version into the main OCFL repository.

Metadata such as the version author’s name, address, and message should be provided at this time. These values are stamped into the new OCFL version’s metadata.

If the repository is not using a known storage layout, and a new object is being committed, then the storage root relative path to the object’s root must be specified.

Fields

pretty_print: bool

Pretty print the version’s inventory.json file

user_name: Option<String>

Name of the user to attribute the changes to

user_address: Option<String>

Address URI of the user to attribute the changes to. For example, mailto:test@example.com

message: Option<String>

Message describing the changes

created: Option<DateTime<Local>>

RFC 3339 creation timestamp of the version. Default: now

Example timestamp: 2020-12-23T10:11:12-06:00

object_root: Option<String>

Storage root relative path to the object’s root

Should only be specified for new objects in repositories without defined storage layouts, and is otherwise ignored.

object_id: String

ID of the object to commit changes for

Trait Implementations

impl Args for CommitCmd

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 Debug for CommitCmd

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

Formats the value using the given formatter.

impl From<CommitCmd> for Command

fn from(v: CommitCmd) -> Command

Performs the conversion.

impl FromArgMatches for CommitCmd

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 TryInto<CommitCmd> for Command

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into(self) -> Result<CommitCmd, <Self as TryInto<CommitCmd>>::Error>

Performs the conversion.