Struct embuild::git::CloneOptions

pub struct CloneOptions {
    pub force_ref: Option<Ref>,
    pub branch_update_action: Option<ResetMode>,
    pub force_clean: bool,
    pub depth: Option<NonZeroU64>,
}

Fields

force_ref: Option<Ref>

Force the working directory to be this specific tag, branch or commit.

On a missmatch between this value and the state of the physical repository, it is deleted and cloned from scratch.

If this option specifies a branch name which maches the current branch of the physical repository and branch_update_action is not None then Repository::clone_ext will try to update the repository with the following commands:

• git reset HEAD <reset mode> (where reset mode is the value of branch_update_action)
• git pull --ff-only If these operations fail an error is returned from Repository::clone_ext.

branch_update_action: Option<ResetMode>

The mode that is passed to git reset when the branch is updated. If None the working directory with branch is never updated.

force_clean: bool

If the working directory is not clean and force_clean is true, the git repo will be cloned from scratch.

depth: Option<NonZeroU64>

The depth that should be cloned, if None the full repository is cloned.

Note that this option is ignored when force_ref specifies a commit.

Implementations

impl CloneOptions

pub fn new() -> Self

pub fn force_ref(self, force_ref: Ref) -> Self

Force the working directory to be this specific tag, branch or commit.

On a missmatch between this value and the state of the physical repository, it is deleted and cloned from scratch.

If this option specifies a branch name which maches the current branch of the physical repository and branch_update_action is not None then Repository::clone_ext will try to update the repository with the following commands:

• git reset HEAD <reset mode> (where reset mode is the value of branch_update_action)
• git pull --ff-only If these operations fail an error is returned from Repository::clone_ext.

pub fn branch_update_action(self, reset_mode: ResetMode) -> Self

The mode that is passed to git reset when the branch is updated. If None the working directory with branch is never updated.

See force_ref for more info.

pub fn force_clean(self) -> Self

If the working directory is not clean and force_clean is true, the git repo will be cloned from scratch.

pub fn depth(self, depth: u64) -> Self

The depth that should be cloned, if None the full repository is cloned.

depth must be greater than zero or else this method will panic.

Note that this option is ignored when force_ref specifies a commit.

Trait Implementations

impl Debug for CloneOptions

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

Formats the value using the given formatter.

impl Default for CloneOptions

fn default() -> CloneOptions

Returns the “default value” for a type.