<!DOCTYPE html><htmllang="en"><head><metacharset="utf-8"><metaname="viewport"content="width=device-width, initial-scale=1.0"><metaname="generator"content="rustdoc"><metaname="description"content="A builder struct for configuring checkouts of a repository."><title>CheckoutBuilder in git2::build - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><linkrel="stylesheet"href="../../static.files/normalize-76eba96aa4d2e634.css"><linkrel="stylesheet"href="../../static.files/rustdoc-dd39b87e5fcfba68.css"><metaname="rustdoc-vars"data-root-path="../../"data-static-root-path="../../static.files/"data-current-crate="git2"data-themes=""data-resource-suffix=""data-rustdoc-version="1.80.0 (051478957 2024-07-21)"data-channel="1.80.0"data-search-js="search-d52510db62a78183.js"data-settings-js="settings-4313503d2e1961c2.js"><scriptsrc="../../static.files/storage-118b08c4c78b968e.js"></script><scriptdefersrc="sidebar-items.js"></script><scriptdefersrc="../../static.files/main-20a3ad099b048cf2.js"></script><noscript><linkrel="stylesheet"href="../../static.files/noscript-df360f571f6edeae.css"></noscript><linkrel="alternate icon"type="image/png"href="../../static.files/favicon-32x32-422f7d1d52889060.png"><linkrel="icon"type="image/svg+xml"href="../../static.files/favicon-2c020d218678b618.svg"></head><bodyclass="rustdoc struct"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><navclass="mobile-topbar"><buttonclass="sidebar-menu-toggle"title="show sidebar"></button></nav><navclass="sidebar"><divclass="sidebar-crate"><h2><ahref="../../git2/index.html">git2</a><spanclass="version">0.18.3</span></h2></div><h2class="location"><ahref="#">CheckoutBuilder</a></h2><divclass="sidebar-elems"><section><h3><ahref="#implementations">Methods</a></h3><ulclass="block method"><li><ahref="#method.allow_conflicts">allow_conflicts</a></li><li><ahref="#method.ancestor_label">ancestor_label</a></li><li><ahref="#method.configure">configure</a></li><li><ahref="#method.conflict_style_diff3">conflict_style_diff3</a></li><li><ahref="#method.conflict_style_merge">conflict_style_merge</a></li><li><ahref="#method.dir_perm">dir_perm</a></li><li><ahref="#method.disable_filters">disable_filters</a></li><li><ahref="#method.dry_run">dry_run</a></li><li><ahref="#method.file_perm">file_perm</a></li><li><ahref="#method.force">force</a></li><li><ahref="#method.new">new</a></li><li><ahref="#method.notify">notify</a></li><li><ahref="#method.notify_on">notify_on</a></li><li><ahref="#method.our_label">our_label</a></li><li><ahref="#method.overwrite_ignored">overwrite_ignored</a></li><li><ahref="#method.path">path</a></li><li><ahref="#method.progress">progress</a></li><li><ahref="#method.recreate_missing">recreate_missing</a></li><li><ahref="#method.refresh">refresh</a></li><li><ahref="#method.remove_ignored">remove_ignored</a></li><li><ahref="#method.remove_untracked">remove_untracked</a></li><li><ahref="#method.safe">safe</a></li><li><ahref="#method.skip_unmerged">skip_unmerged</a></li><li><ahref="#method.target_dir">target_dir</a></li><li><ahref="#method.their_label">their_label</a></li><li><ahref="#method.update_index">update_index</a></li><li><ahref="#method.update_only">update_only</a></li><li><ahref="#method.use_ours">use_ours</a></li><li><ahref="#method.use_theirs">use_theirs</a></li></ul><h3><ahref="#trait-implementations">Trait Implementations</a></h3><ulclass="block trait-implementation"><li><ahref="#impl-Default-for-CheckoutBuilder%3C'cb%3E">Default</a></li></ul><h3><ahref="#synthetic-implementations">Auto Tra
</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-CheckoutBuilder%3C'cb%3E"class="impl"><aclass="src rightside"href="../../src/git2/build.rs.html#326-618">source</a><ahref="#impl-CheckoutBuilder%3C'cb%3E"class="anchor">§</a><h3class="code-header">impl<'cb><aclass="struct"href="struct.CheckoutBuilder.html"title="struct git2::build::CheckoutBuilder">CheckoutBuilder</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/build.rs.html#329-346">source</a><h4class="code-header">pub fn <ahref="#method.new"class="fn">new</a>() -><aclass="struct"href="struct.CheckoutBuilder.html"title="struct git2::build::CheckoutBuilder">CheckoutBuilder</a><'cb></h4></section></summary><divclass="docblock"><p>Creates a new builder for checkouts with all of its default
configuration.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.dry_run"class="method"><aclass="src rightside"href="../../src/git2/build.rs.html#350-354">source</a><h4class="code-header">pub fn <ahref="#method.dry_run"class="fn">dry_run</a>(&mut self) ->&mut <aclass="struct"href="struct.CheckoutBuilder.html"title="struct git2::build::CheckoutBuilder">CheckoutBuilder</a><'cb></h4></section></summary><divclass="docblock"><p>Indicate that this checkout should perform a dry run by checking for
conflicts but not make any actual changes.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.force"class="method"><aclass="src rightside"href="../../src/git2/build.rs.html#358-362">source</a><h4class="code-header">pub fn <ahref="#method.force"class="fn">force</a>(&mut self) ->&mut <aclass="struct"href="struct.CheckoutBuilder.html"title="struct git2::build::CheckoutBuilder">CheckoutBuilder</a><'cb></h4></section></summary><divclass="docblock"><p>Take any action necessary to get the working directory to match the
target including potentially discarding modified files.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.safe"class="method"><aclass="src rightside"href="../../src/git2/build.rs.html#368-372">source</a><h4class="code-header">pub fn <ahref="#method.safe"class="fn">safe</a>(&mut self) ->&mut <aclass="struct"href="struct.CheckoutBuilder.html"title="struct git2::build::CheckoutBuilder">CheckoutBuilder</a><'cb></h4></section></summary><divclass="docblock"><p>Indicate that the checkout should be performed safely, allowing new
files to be created but not overwriting existing files or changes.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.update_index"class="method"><aclass="src rightside"href="../../src/git2/build.rs.html#425-427">source</a><h4class="code-header">pub fn <ahref="#method.update_index"class="fn">update_index</a>(&mut self, update: <aclass="primitive"href="https://doc.rust-lang.org/1.80.0/std/primitive.bool.html">bool</a>) ->&mut <aclass="struct"href="struct.CheckoutBuilder.html"title="struct git2::build::CheckoutBuilder">CheckoutBuilder</a><'cb></h4></section></summary><divclass="docblock"><p>Prevents checkout from writing the updated files’ information to the
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.refresh"class="method"><aclass="src rightside"href="../../src/git2/build.rs.html#433-435">source</a><h4class="code-header">pub fn <ahref="#method.refresh"class="fn">refresh</a>(&mut self, refresh: <aclass="primitive"href="https://doc.rust-lang.org/1.80.0/std/primitive.bool.html">bool</a>) ->&mut <aclass="struct"href="struct.CheckoutBuilder.html"title="struct git2::build::CheckoutBuilder">CheckoutBuilder</a><'cb></h4></section></summary><divclass="docblock"><p>Indicate whether the index and git attributes should be refreshed from
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.use_ours"class="method"><aclass="src rightside"href="../../src/git2/build.rs.html#448-450">source</a><h4class="code-header">pub fn <ahref="#method.use_ours"class="fn">use_ours</a>(&mut self, ours: <aclass="primitive"href="https://doc.rust-lang.org/1.80.0/std/primitive.bool.html">bool</a>) ->&mut <aclass="struct"href="struct.CheckoutBuilder.html"title="struct git2::build::CheckoutBuilder">CheckoutBuilder</a><'cb></h4></section></summary><divclass="docblock"><p>Indicate whether the checkout should proceed on conflicts by using the
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.use_theirs"class="method"><aclass="src rightside"href="../../src/git2/build.rs.html#456-458">source</a><h4class="code-header">pub fn <ahref="#method.use_theirs"class="fn">use_theirs</a>(&mut self, theirs: <aclass="primitive"href="https://doc.rust-lang.org/1.80.0/std/primitive.bool.html">bool</a>) ->&mut <aclass="struct"href="struct.CheckoutBuilder.html"title="struct git2::build::CheckoutBuilder">CheckoutBuilder</a><'cb></h4></section></summary><divclass="docblock"><p>Indicate whether the checkout should proceed on conflicts by using the
) ->&mut <aclass="struct"href="struct.CheckoutBuilder.html"title="struct git2::build::CheckoutBuilder">CheckoutBuilder</a><'cb></h4></section></summary><divclass="docblock"><p>Indicate whether ignored files should be overwritten during the checkout.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.conflict_style_merge"class="method"><aclass="src rightside"href="../../src/git2/build.rs.html#470-472">source</a><h4class="code-header">pub fn <ahref="#method.conflict_style_merge"class="fn">conflict_style_merge</a>(&mut self, on: <aclass="primitive"href="https://doc.rust-lang.org/1.80.0/std/primitive.bool.html">bool</a>) ->&mut <aclass="struct"href="struct.CheckoutBuilder.html"title="struct git2::build::CheckoutBuilder">CheckoutBuilder</a><'cb></h4></section></summary><divclass="docblock"><p>Indicate whether a normal merge file should be written for conflicts.</p>
) ->&mut <aclass="struct"href="struct.CheckoutBuilder.html"title="struct git2::build::CheckoutBuilder">CheckoutBuilder</a><'cb></h4></section></summary><divclass="docblock"><p>Specify for which notification types to invoke the notification
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.conflict_style_diff3"class="method"><aclass="src rightside"href="../../src/git2/build.rs.html#490-492">source</a><h4class="code-header">pub fn <ahref="#method.conflict_style_diff3"class="fn">conflict_style_diff3</a>(&mut self, on: <aclass="primitive"href="https://doc.rust-lang.org/1.80.0/std/primitive.bool.html">bool</a>) ->&mut <aclass="struct"href="struct.CheckoutBuilder.html"title="struct git2::build::CheckoutBuilder">CheckoutBuilder</a><'cb></h4></section></summary><divclass="docblock"><p>Indicates whether to include common ancestor data in diff3 format files
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.disable_filters"class="method"><aclass="src rightside"href="../../src/git2/build.rs.html#495-498">source</a><h4class="code-header">pub fn <ahref="#method.disable_filters"class="fn">disable_filters</a>(&mut self, disable: <aclass="primitive"href="https://doc.rust-lang.org/1.80.0/std/primitive.bool.html">bool</a>) ->&mut <aclass="struct"href="struct.CheckoutBuilder.html"title="struct git2::build::CheckoutBuilder">CheckoutBuilder</a><'cb></h4></section></summary><divclass="docblock"><p>Indicate whether to apply filters like CRLF conversion.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.dir_perm"class="method"><aclass="src rightside"href="../../src/git2/build.rs.html#503-506">source</a><h4class="code-header">pub fn <ahref="#method.dir_perm"class="fn">dir_perm</a>(&mut self, perm: <aclass="primitive"href="https://doc.rust-lang.org/1.80.0/std/primitive.i32.html">i32</a>) ->&mut <aclass="struct"href="struct.CheckoutBuilder.html"title="struct git2::build::CheckoutBuilder">CheckoutBuilder</a><'cb></h4></section></summary><divclass="docblock"><p>Set the mode with which new directories are created.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.file_perm"class="method"><aclass="src rightside"href="../../src/git2/build.rs.html#511-514">source</a><h4class="code-header">pub fn <ahref="#method.file_perm"class="fn">file_perm</a>(&mut self, perm: <aclass="primitive"href="https://doc.rust-lang.org/1.80.0/std/primitive.i32.html">i32</a>) ->&mut <aclass="struct"href="struct.CheckoutBuilder.html"title="struct git2::build::CheckoutBuilder">CheckoutBuilder</a><'cb></h4></section></summary><divclass="docblock"><p>Set the mode with which new files are created.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.target_dir"class="method"><aclass="src rightside"href="../../src/git2/build.rs.html#528-532">source</a><h4class="code-header">pub fn <ahref="#method.target_dir"class="fn">target_dir</a>(&mut self, dst: &<aclass="struct"href="https://doc.rust-lang.org/1.80.0/std/path/struct.Path.html"title="struct std::path::Path">Path</a>) ->&mut <aclass="struct"href="struct.CheckoutBuilder.html"title="struct git2::build::CheckoutBuilder">CheckoutBuilder</a><'cb></h4></section></summary><divclass="docblock"><p>Set the directory to check out to</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.ancestor_label"class="method"><aclass="src rightside"href="../../src/git2/build.rs.html#535-538">source</a><h4class="code-header">pub fn <ahref="#method.ancestor_label"class="fn">ancestor_label</a>(&mut self, label: &<aclass="primitive"href="https://doc.rust-lang.org/1.80.0/std/primitive.str.html">str</a>) ->&mut <aclass="struct"href="struct.CheckoutBuilder.html"title="struct git2::build::CheckoutBuilder">CheckoutBuilder</a><'cb></h4></section></summary><divclass="docblock"><p>The name of the common ancestor side of conflicts</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.our_label"class="method"><aclass="src rightside"href="../../src/git2/build.rs.html#541-544">source</a><h4class="code-header">pub fn <ahref="#method.our_label"class="fn">our_label</a>(&mut self, label: &<aclass="primitive"href="https://doc.rust-lang.org/1.80.0/std/primitive.str.html">str</a>) ->&mut <aclass="struct"href="struct.CheckoutBuilder.html"title="struct git2::build::CheckoutBuilder">CheckoutBuilder</a><'cb></h4></section></summary><divclass="docblock"><p>The name of the common our side of conflicts</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.their_label"class="method"><aclass="src rightside"href="../../src/git2/build.rs.html#547-550">source</a><h4class="code-header">pub fn <ahref="#method.their_label"class="fn">their_label</a>(&mut self, label: &<aclass="primitive"href="https://doc.rust-lang.org/1.80.0/std/primitive.str.html">str</a>) ->&mut <aclass="struct"href="struct.CheckoutBuilder.html"title="struct git2::build::CheckoutBuilder">CheckoutBuilder</a><'cb></h4></section></summary><divclass="docblock"><p>The name of the common their side of conflicts</p>
<p>Callbacks are invoked prior to modifying any files on disk.
Returning <code>false</code> from the callback will cancel the checkout.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.configure"class="method"><aclass="src rightside"href="../../src/git2/build.rs.html#584-617">source</a><h4class="code-header">pub unsafe fn <ahref="#method.configure"class="fn">configure</a>(&mut self, opts: &mut <aclass="struct"href="../../libgit2_sys/struct.git_checkout_options.html"title="struct libgit2_sys::git_checkout_options">git_checkout_options</a>)</h4></section></summary><divclass="docblock"><p>Configure a raw checkout options based on this configuration.</p>
<p>This method is unsafe as there is no guarantee that this structure will
<code><ahref="https://doc.rust-lang.org/1.80.0/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.80.0/src/core/convert/mod.rs.html#805-807">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.80.0/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.80.0/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"class="associatedtype trait-impl"><ahref="#associatedtype.Error"class="anchor">§</a><h4class="code-header">type <ahref="https://doc.rust-lang.org/1.80.0/core/convert/trait.TryFrom.html#associatedtype.Error"class="associatedtype">Error</a> = <aclass="enum"href="https://doc.rust-lang.org/1.80.0/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.80.0/src/core/convert/mod.rs.html#812">source</a><ahref="#method.try_from"class="anchor">§</a><h4class="code-header">fn <ahref="https://doc.rust-lang.org/1.80.0/core/convert/trait.TryFrom.html#tymethod.try_from"class="fn">try_from</a>(value: U) -><aclass="enum"href="https://doc.rust-lang.org/1.80.0/core/result/enum.Result.html"title="enum core::result::Result">Result</a><T, <T as <aclass="trait"href="https://doc.rust-lang.org/1.80.0/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><U>>::<aclass="associatedtype"href="https://doc.rust-lang.org/1.80.0/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.80.0/src/core/convert/mod.rs.html#790-792">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.80.0/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.80.0/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-1"class="associatedtype trait-impl"><ahref="#associatedtype.Error-1"class="anchor">§</a><h4class="code-header">type <ahref="https://doc.rust-lang.org/1.80.0/core/convert/trait.TryInto.html#associatedtype.Error"class="associatedtype">Error</a> = <U as <aclass="trait"href="https://doc.rust-lang.org/1.80.0/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><T>>::<aclass="associatedtype"href="https://doc.rust-lang.org/1.80.0/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.80.0/src/core/convert/mod.rs.html#797">source</a><ahref="#method.try_into"class="anchor">§</a><h4class="code-header">fn <ahref="https://doc.rust-lang.org/1.80.0/core/convert/trait.TryInto.html#tymethod.try_into"class="fn">try_into</a>(self) -><aclass="enum"href="https://doc.rust-lang.org/1.80.0/core/result/enum.Result.html"title="enum core::result::Result">Result</a><U, <U as <aclass="trait"href="https://doc.rust-lang.org/1.80.0/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><T>>::<aclass="associatedtype"href="https://doc.rust-lang.org/1.80.0/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>
