Struct git2::RebaseOptions

pub struct RebaseOptions<'cb> { /* fields omitted */ }

Rebase options

Use to tell the rebase machinery how to operate.

Implementations

impl<'cb> RebaseOptions<'cb>

pub fn new() -> RebaseOptions<'cb>

Creates a new default set of rebase options.

pub fn quiet(&mut self, quiet: bool) -> &mut RebaseOptions<'cb>

Used by Repository::rebase, this will instruct other clients working on this rebase that you want a quiet rebase experience, which they may choose to provide in an application-specific manner. This has no effect upon libgit2 directly, but is provided for interoperability between Git tools.

pub fn inmemory(&mut self, inmemory: bool) -> &mut RebaseOptions<'cb>

Used by Repository::rebase, this will begin an in-memory rebase, which will allow callers to step through the rebase operations and commit the rebased changes, but will not rewind HEAD or update the repository to be in a rebasing state. This will not interfere with the working directory (if there is one).

pub fn rewrite_notes_ref(
    &mut self,
    rewrite_notes_ref: &str
) -> &mut RebaseOptions<'cb>

Used by finish(), this is the name of the notes reference used to rewrite notes for rebased commits when finishing the rebase; if NULL, the contents of the configuration option notes.rewriteRef is examined, unless the configuration option notes.rewrite.rebase is set to false. If notes.rewriteRef is also NULL, notes will not be rewritten.

pub fn merge_options(&mut self, opts: MergeOptions) -> &mut RebaseOptions<'cb>

Options to control how trees are merged during next().

pub fn checkout_options(
    &mut self,
    opts: CheckoutBuilder<'cb>
) -> &mut RebaseOptions<'cb>

Options to control how files are written during Repository::rebase, next() and abort(). Note that a minimum strategy of GIT_CHECKOUT_SAFE is defaulted in init and next, and a minimum strategy of GIT_CHECKOUT_FORCE is defaulted in abort to match git semantics.

pub fn raw(&mut self) -> *const git_rebase_options

Acquire a pointer to the underlying raw options.

Trait Implementations

impl<'cb> Default for RebaseOptions<'cb>

fn default() -> Self

Returns the "default value" for a type.