<main><divclass="width-limiter"><navclass="sub"><formclass="search-form"><span></span><divid="sidebar-button"tabindex="-1"><ahref="../git2/all.html"title="show sidebar"></a></div><inputclass="search-input"name="search"aria-label="Run search in the documentation"autocomplete="off"spellcheck="false"placeholder="Click or press ‘S’ to search, ‘?’ for more options…"type="search"><divid="help-button"tabindex="-1"><ahref="../help.html"title="help">?</a></div><divid="settings-menu"tabindex="-1"><ahref="../settings.html"title="settings"><imgwidth="22"height="22"alt="Change settings"src="../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><sectionid="main-content"class="content"><divclass="main-heading"><h1>Struct <ahref="index.html">git2</a>::<wbr><aclass="struct"href="#">RebaseOptions</a><buttonid="copy-path"title="Copy item path to clipboard"><imgsrc="../static.files/clipboard-7571035ce49a181d.svg"width="19"height="18"alt="Copy item path"></button></h1><spanclass="out-of-band"><aclass="src"href="../src/git2/rebase.rs.html#11-16">source</a> · <buttonid="toggle-all-docs"title="collapse all docs">[<span>−</span>]</button></span></div><preclass="rust item-decl"><code>pub struct RebaseOptions<'cb> { <spanclass="comment">/* private fields */</span> }</code></pre><detailsclass="toggle top-doc"open><summaryclass="hideme"><span>Expand description</span></summary><divclass="docblock"><p>Rebase options</p>
<p>Use to tell the rebase machinery how to operate.</p>
</div></details><h2id="implementations"class="section-header">Implementations<ahref="#implementations"class="anchor">§</a></h2><divid="implementations-list"><detailsclass="toggle implementors-toggle"open><summary><sectionid="impl-RebaseOptions%3C'cb%3E"class="impl"><aclass="src rightside"href="../src/git2/rebase.rs.html#24-101">source</a><ahref="#impl-RebaseOptions%3C'cb%3E"class="anchor">§</a><h3class="code-header">impl<'cb><aclass="struct"href="struct.RebaseOptions.html"title="struct git2::RebaseOptions">RebaseOptions</a><'cb></h3></section></summary><divclass="impl-items"><detailsclass="toggle method-toggle"open><summary><sectionid="method.new"class="method"><aclass="src rightside"href="../src/git2/rebase.rs.html#26-35">source</a><h4class="code-header">pub fn <ahref="#method.new"class="fn">new</a>() -><aclass="struct"href="struct.RebaseOptions.html"title="struct git2::RebaseOptions">RebaseOptions</a><'cb></h4></section></summary><divclass="docblock"><p>Creates a new default set of rebase options.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.quiet"class="method"><aclass="src rightside"href="../src/git2/rebase.rs.html#42-45">source</a><h4class="code-header">pub fn <ahref="#method.quiet"class="fn">quiet</a>(&mut self, quiet: <aclass="primitive"href="https://doc.rust-lang.org/1.77.2/std/primitive.bool.html">bool</a>) ->&mut <aclass="struct"href="struct.RebaseOptions.html"title="struct git2::RebaseOptions">RebaseOptions</a><'cb></h4></section></summary><divclass="docblock"><p>Used by <code>Repository::rebase</code>, this will instruct other clients working on this
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.inmemory"class="method"><aclass="src rightside"href="../src/git2/rebase.rs.html#52-55">source</a><h4class="code-header">pub fn <ahref="#method.inmemory"class="fn">inmemory</a>(&mut self, inmemory: <aclass="primitive"href="https://doc.rust-lang.org/1.77.2/std/primitive.bool.html">bool</a>) ->&mut <aclass="struct"href="struct.RebaseOptions.html"title="struct git2::RebaseOptions">RebaseOptions</a><'cb></h4></section></summary><divclass="docblock"><p>Used by <code>Repository::rebase</code>, this will begin an in-memory rebase,
) ->&mut <aclass="struct"href="struct.RebaseOptions.html"title="struct git2::RebaseOptions">RebaseOptions</a><'cb></h4></section></summary><divclass="docblock"><p>Used by <code>finish()</code>, 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 <code>notes.rewriteRef</code>
is examined, unless the configuration option <code>notes.rewrite.rebase</code>
is set to false. If <code>notes.rewriteRef</code> is also NULL, notes will
not be rewritten.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.merge_options"class="method"><aclass="src rightside"href="../src/git2/rebase.rs.html#69-72">source</a><h4class="code-header">pub fn <ahref="#method.merge_options"class="fn">merge_options</a>(&mut self, opts: <aclass="struct"href="struct.MergeOptions.html"title="struct git2::MergeOptions">MergeOptions</a>) ->&mut <aclass="struct"href="struct.RebaseOptions.html"title="struct git2::RebaseOptions">RebaseOptions</a><'cb></h4></section></summary><divclass="docblock"><p>Options to control how trees are merged during <code>next()</code>.</p>
) ->&mut <aclass="struct"href="struct.RebaseOptions.html"title="struct git2::RebaseOptions">RebaseOptions</a><'cb></h4></section></summary><divclass="docblock"><p>Options to control how files are written during <code>Repository::rebase</code>,
<code>next()</code> and <code>abort()</code>. Note that a minimum strategy of
<code>GIT_CHECKOUT_SAFE</code> is defaulted in <code>init</code> and <code>next</code>, and a minimum
strategy of <code>GIT_CHECKOUT_FORCE</code> is defaulted in <code>abort</code> to match git
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.raw"class="method"><aclass="src rightside"href="../src/git2/rebase.rs.html#85-100">source</a><h4class="code-header">pub fn <ahref="#method.raw"class="fn">raw</a>(&mut self) -><aclass="primitive"href="https://doc.rust-lang.org/1.77.2/std/primitive.pointer.html">*const </a><aclass="struct"href="../libgit2_sys/struct.git_rebase_options.html"title="struct libgit2_sys::git_rebase_options">git_rebase_options</a></h4></section></summary><divclass="docblock"><p>Acquire a pointer to the underlying raw options.</p>
</div></details></div></details></div><h2id="trait-implementations"class="section-header">Trait Implementations<ahref="#trait-implementations"class="anchor">§</a></h2><divid="trait-implementations-list"><detailsclass="toggle implementors-toggle"open><summary><sectionid="impl-Default-for-RebaseOptions%3C'cb%3E"class="impl"><aclass="src rightside"href="../src/git2/rebase.rs.html#18-22">source</a><ahref="#impl-Default-for-RebaseOptions%3C'cb%3E"class="anchor">§</a><h3class="code-header">impl<'cb><aclass="trait"href="https://doc.rust-lang.org/1.77.2/core/default/trait.Default.html"title="trait core::default::Default">Default</a> for <aclass="struct"href="struct.RebaseOptions.html"title="struct git2::RebaseOptions">RebaseOptions</a><'cb></h3></section></summary><divclass="impl-items"><detailsclass="toggle method-toggle"open><summary><sectionid="method.default"class="method trait-impl"><aclass="src rightside"href="../src/git2/rebase.rs.html#19-21">source</a><ahref="#method.default"class="anchor">§</a><h4class="code-header">fn <ahref="https://doc.rust-lang.org/1.77.2/core/default/trait.Default.html#tymethod.default"class="fn">default</a>() -> Self</h4></section></summary><divclass='docblock'>Returns the “default value” for a type. <ahref="https://doc.rust-lang.org/1.77.2/core/default/trait.Default.html#tymethod.default">Read more</a></div></details></div></details></div><h2id="synthetic-implementations"class="section-header">Auto Trait Implementations<ahref="#synthetic-implementations"class="anchor">§</a></h2><divid="synthetic-implementations-list"><sectionid="impl-RefUnwindSafe-for-RebaseOptions%3C'cb%3E"class="impl"><ahref="#impl-RefUnwindSafe-for-RebaseOptions%3C'cb%3E"class="anchor">§</a><h3class="code-header">impl<'cb> !<aclass="trait"href="https://doc.rust-lang.org/1.77.2/core/panic/unwind_safe/trait.RefUnwindSafe.html"title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a> for <aclass="struct"href="struct.RebaseOptions.html"title="struct git2::RebaseOptions">RebaseOptions</a><'cb></h3></section><sectionid="impl-Send-for-RebaseOptions%3C'cb%3E"class="impl"><ahref="#impl-Send-for-RebaseOptions%3C'cb%3E"class="anchor">§</a><h3class="code-header">impl<'cb> !<aclass="trait"href="https://doc.rust-lang.org/1.77.2/core/marker/trait.Send.html"title="trait core::marker::Send">Send</a> for <aclass="struct"href="struct.RebaseOptions.html"title="struct git2::RebaseOptions">RebaseOptions</a><'cb></h3></section><sectionid="impl-Sync-for-RebaseOptions%3C'cb%3E"class="impl"><ahref="#impl-Sync-for-RebaseOptions%3C'cb%3E"class="anchor">§</a><h3class="code-header">impl<'cb> !<aclass="trait"href="https://doc.rust-lang.org/1.77.2/core/marker/trait.Sync.html"title="trait core::marker::Sync">Sync</a> for <aclass="struct"href="struct.RebaseOptions.html"title="struct git2::RebaseOptions">RebaseOptions</a><'cb></h3></section><sectionid="impl-Unpin-for-RebaseOptions%3C'cb%3E"class="impl"><ahref="#impl-Unpin-for-RebaseOptions%3C'cb%3E"class="anchor">§</a><h3class="code-header">impl<'cb><aclass="trait"href="https://doc.rust-lang.org/1.77.2/core/marker/trait.Unpin.html"title="trait core::marker::Unpin">Unpin</a> for <aclass="struct"href="struct.RebaseOptions.html"title="struct git2::RebaseOptions">RebaseOptions</a><'cb></h3></section><sectionid="impl-UnwindSafe-for-RebaseOptions%3C'cb%3E"class="impl"><ahref="#impl-UnwindSafe-for-RebaseOptions%3C'cb%3E"class="anchor">§</a><h3class="code-header">impl<'cb> !<aclass="trait"href="https://doc.rust-lang.org/1.77.2/core/panic/unwind_safe/trait.UnwindSafe.html"title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a> for <aclass="struct"href="struct.RebaseOptions.html"title="struct git2::RebaseOptions">RebaseOptions</a><'cb></h3></section></div><h2id="blanket-implementations"class="section-header">Blanket Implementations<ahref="#blanket-implementations"class="anchor">§</a></h2><divid="blanket-implem
T: 'static + ?<aclass="trait"href="https://doc.rust-lang.org/1.77.2/core/marker/trait.Sized.html"title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><divclass="impl-items"><detailsclass="toggle method-toggle"open><summary><sectionid="method.type_id"class="method trait-impl"><aclass="src rightside"href="https://doc.rust-lang.org/1.77.2/src/core/any.rs.html#141">source</a><ahref="#method.type_id"class="anchor">§</a><h4class="code-header">fn <ahref="https://doc.rust-lang.org/1.77.2/core/any/trait.Any.html#tymethod.type_id"class="fn">type_id</a>(&self) -><aclass="struct"href="https://doc.rust-lang.org/1.77.2/core/any/struct.TypeId.html"title="struct core::any::TypeId">TypeId</a></h4></section></summary><divclass='docblock'>Gets the <code>TypeId</code> of <code>self</code>. <ahref="https://doc.rust-lang.org/1.77.2/core/any/trait.Any.html#tymethod.type_id">Read more</a></div></details></div></details><detailsclass="toggle implementors-toggle"><summary><sectionid="impl-Borrow%3CT%3E-for-T"class="impl"><aclass="src rightside"href="https://doc.rust-lang.org/1.77.2/src/core/borrow.rs.html#208">source</a><ahref="#impl-Borrow%3CT%3E-for-T"class="anchor">§</a><h3class="code-header">impl<T><aclass="trait"href="https://doc.rust-lang.org/1.77.2/core/borrow/trait.Borrow.html"title="trait core::borrow::Borrow">Borrow</a><T> for T<divclass="where">where
T: ?<aclass="trait"href="https://doc.rust-lang.org/1.77.2/core/marker/trait.Sized.html"title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><divclass="impl-items"><detailsclass="toggle method-toggle"open><summary><sectionid="method.borrow"class="method trait-impl"><aclass="src rightside"href="https://doc.rust-lang.org/1.77.2/src/core/borrow.rs.html#210">source</a><ahref="#method.borrow"class="anchor">§</a><h4class="code-header">fn <ahref="https://doc.rust-lang.org/1.77.2/core/borrow/trait.Borrow.html#tymethod.borrow"class="fn">borrow</a>(&self) -><aclass="primitive"href="https://doc.rust-lang.org/1.77.2/std/primitive.reference.html">&T</a></h4></section></summary><divclass='docblock'>Immutably borrows from an owned value. <ahref="https://doc.rust-lang.org/1.77.2/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></div></details></div></details><detailsclass="toggle implementors-toggle"><summary><sectionid="impl-BorrowMut%3CT%3E-for-T"class="impl"><aclass="src rightside"href="https://doc.rust-lang.org/1.77.2/src/core/borrow.rs.html#216">source</a><ahref="#impl-BorrowMut%3CT%3E-for-T"class="anchor">§</a><h3class="code-header">impl<T><aclass="trait"href="https://doc.rust-lang.org/1.77.2/core/borrow/trait.BorrowMut.html"title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T<divclass="where">where
T: ?<aclass="trait"href="https://doc.rust-lang.org/1.77.2/core/marker/trait.Sized.html"title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><divclass="impl-items"><detailsclass="toggle method-toggle"open><summary><sectionid="method.borrow_mut"class="method trait-impl"><aclass="src rightside"href="https://doc.rust-lang.org/1.77.2/src/core/borrow.rs.html#217">source</a><ahref="#method.borrow_mut"class="anchor">§</a><h4class="code-header">fn <ahref="https://doc.rust-lang.org/1.77.2/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut"class="fn">borrow_mut</a>(&mut self) -><aclass="primitive"href="https://doc.rust-lang.org/1.77.2/std/primitive.reference.html">&mut T</a></h4></section></summary><divclass='docblock'>Mutably borrows from an owned value. <ahref="https://doc.rust-lang.org/1.77.2/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></div></details></div></details><detailsclass="toggle implementors-toggle"><summary><sectionid="impl-From%3CT%3E-for-T"class="impl"><aclass="src rightside"href="https://doc.rust-lang.org/1.77.2/src/core/convert/mod.rs.html#764">source</a><ahref="#impl-From%3CT%3E-for-T"class="anchor">§</a><h3class="code-header">impl<T><aclass="trait"href="https://doc.rust-lang.org/1.77.2/core/convert/trait.From.html"title="trait core::convert::From">From</a><T> for T</h3></section></summary><divclass="impl-items"><detailsclass="toggle method-toggle"open><summary><sectionid="method.from"class="method trait-impl"><aclass="src rightside"href="https://doc.rust-lang.org/1.77.2/src/core/convert/mod.rs.html#767">source</a><ahref="#method.from"class="anchor">§</a><h4class="code-header">fn <ahref="https://doc.rust-lang.org/1.77.2/core/convert/trait.From.html#tymethod.from"class="fn">from</a>(t: T) -> T</h4></section></summary><divclass="docblock"><p>Returns the argument unchanged.</p>
</div></details></div></details><detailsclass="toggle implementors-toggle"><summary><sectionid="impl-Into%3CU%3E-for-T"class="impl"><aclass="src rightside"href="https://doc.rust-lang.org/1.77.2/src/core/convert/mod.rs.html#747-749">source</a><ahref="#impl-Into%3CU%3E-for-T"class="anchor">§</a><h3class="code-header">impl<T, U><aclass="trait"href="https://doc.rust-lang.org/1.77.2/core/convert/trait.Into.html"title="trait core::convert::Into">Into</a><U> for T<divclass="where">where
<code><ahref="https://doc.rust-lang.org/1.77.2/core/convert/trait.From.html"title="trait core::convert::From">From</a><T> for U</code> chooses to do.</p>
</div></details></div></details><detailsclass="toggle implementors-toggle"><summary><sectionid="impl-TryFrom%3CU%3E-for-T"class="impl"><aclass="src rightside"href="https://doc.rust-lang.org/1.77.2/src/core/convert/mod.rs.html#804-806">source</a><ahref="#impl-TryFrom%3CU%3E-for-T"class="anchor">§</a><h3class="code-header">impl<T, U><aclass="trait"href="https://doc.rust-lang.org/1.77.2/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><U> for T<divclass="where">where
U: <aclass="trait"href="https://doc.rust-lang.org/1.77.2/core/convert/trait.Into.html"title="trait core::convert::Into">Into</a><T>,</div></h3></section></summary><divclass="impl-items"><detailsclass="toggle"open><summary><sectionid="associatedtype.Error-1"class="associatedtype trait-impl"><ahref="#associatedtype.Error-1"class="anchor">§</a><h4class="code-header">type <ahref="https://doc.rust-lang.org/1.77.2/core/convert/trait.TryFrom.html#associatedtype.Error"class="associatedtype">Error</a> = <aclass="enum"href="https://doc.rust-lang.org/1.77.2/core/convert/enum.Infallible.html"title="enum core::convert::Infallible">Infallible</a></h4></section></summary><divclass='docblock'>The type returned in the event of a conversion error.</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.try_from"class="method trait-impl"><aclass="src rightside"href="https://doc.rust-lang.org/1.77.2/src/core/convert/mod.rs.html#811">source</a><ahref="#method.try_from"class="anchor">§</a><h4class="code-header">fn <ahref="https://doc.rust-lang.org/1.77.2/core/convert/trait.TryFrom.html#tymethod.try_from"class="fn">try_from</a>(value: U) -><aclass="enum"href="https://doc.rust-lang.org/1.77.2/core/result/enum.Result.html"title="enum core::result::Result">Result</a><T, <T as <aclass="trait"href="https://doc.rust-lang.org/1.77.2/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><U>>::<aclass="associatedtype"href="https://doc.rust-lang.org/1.77.2/core/convert/trait.TryFrom.html#associatedtype.Error"title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><divclass='docblock'>Performs the conversion.</div></details></div></details><detailsclass="toggle implementors-toggle"><summary><sectionid="impl-TryInto%3CU%3E-for-T"class="impl"><aclass="src rightside"href="https://doc.rust-lang.org/1.77.2/src/core/convert/mod.rs.html#789-791">source</a><ahref="#impl-TryInto%3CU%3E-for-T"class="anchor">§</a><h3class="code-header">impl<T, U><aclass="trait"href="https://doc.rust-lang.org/1.77.2/core/convert/trait.TryInto.html"title="trait core::convert::TryInto">TryInto</a><U> for T<divclass="where">where
U: <aclass="trait"href="https://doc.rust-lang.org/1.77.2/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><T>,</div></h3></section></summary><divclass="impl-items"><detailsclass="toggle"open><summary><sectionid="associatedtype.Error"class="associatedtype trait-impl"><ahref="#associatedtype.Error"class="anchor">§</a><h4class="code-header">type <ahref="https://doc.rust-lang.org/1.77.2/core/convert/trait.TryInto.html#associatedtype.Error"class="associatedtype">Error</a> = <U as <aclass="trait"href="https://doc.rust-lang.org/1.77.2/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><T>>::<aclass="associatedtype"href="https://doc.rust-lang.org/1.77.2/core/convert/trait.TryFrom.html#associatedtype.Error"title="type core::convert::TryFrom::Error">Error</a></h4></section></summary><divclass='docblock'>The type returned in the event of a conversion error.</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.try_into"class="method trait-impl"><aclass="src rightside"href="https://doc.rust-lang.org/1.77.2/src/core/convert/mod.rs.html#796">source</a><ahref="#method.try_into"class="anchor">§</a><h4class="code-header">fn <ahref="https://doc.rust-lang.org/1.77.2/core/convert/trait.TryInto.html#tymethod.try_into"class="fn">try_into</a>(self) -><aclass="enum"href="https://doc.rust-lang.org/1.77.2/core/result/enum.Result.html"title="enum core::result::Result">Result</a><U, <U as <aclass="trait"href="https://doc.rust-lang.org/1.77.2/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><T>>::<aclass="associatedtype"href="https://doc.rust-lang.org/1.77.2/core/convert/trait.TryFrom.html#associatedtype.Error"title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><divclass='docblock'>Performs the conversion.</div></details></div></details></div></section></div></main></body></html>
