mirror of
https://github.com/edg-l/edlang.git
synced 2024-11-23 00:18:24 +00:00
84 lines
44 KiB
HTML
84 lines
44 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="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><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-dd39b87e5fcfba68.css"><meta name="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" ><script src="../../static.files/storage-118b08c4c78b968e.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-20a3ad099b048cf2.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-df360f571f6edeae.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc struct"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../git2/index.html">git2</a><span class="version">0.18.3</span></h2></div><h2 class="location"><a href="#">CheckoutBuilder</a></h2><div class="sidebar-elems"><section><h3><a href="#implementations">Methods</a></h3><ul class="block method"><li><a href="#method.allow_conflicts">allow_conflicts</a></li><li><a href="#method.ancestor_label">ancestor_label</a></li><li><a href="#method.configure">configure</a></li><li><a href="#method.conflict_style_diff3">conflict_style_diff3</a></li><li><a href="#method.conflict_style_merge">conflict_style_merge</a></li><li><a href="#method.dir_perm">dir_perm</a></li><li><a href="#method.disable_filters">disable_filters</a></li><li><a href="#method.dry_run">dry_run</a></li><li><a href="#method.file_perm">file_perm</a></li><li><a href="#method.force">force</a></li><li><a href="#method.new">new</a></li><li><a href="#method.notify">notify</a></li><li><a href="#method.notify_on">notify_on</a></li><li><a href="#method.our_label">our_label</a></li><li><a href="#method.overwrite_ignored">overwrite_ignored</a></li><li><a href="#method.path">path</a></li><li><a href="#method.progress">progress</a></li><li><a href="#method.recreate_missing">recreate_missing</a></li><li><a href="#method.refresh">refresh</a></li><li><a href="#method.remove_ignored">remove_ignored</a></li><li><a href="#method.remove_untracked">remove_untracked</a></li><li><a href="#method.safe">safe</a></li><li><a href="#method.skip_unmerged">skip_unmerged</a></li><li><a href="#method.target_dir">target_dir</a></li><li><a href="#method.their_label">their_label</a></li><li><a href="#method.update_index">update_index</a></li><li><a href="#method.update_only">update_only</a></li><li><a href="#method.use_ours">use_ours</a></li><li><a href="#method.use_theirs">use_theirs</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block trait-implementation"><li><a href="#impl-Default-for-CheckoutBuilder%3C'cb%3E">Default</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block synthetic-implementation"><li><a href="#impl-RefUnwindSafe-for-CheckoutBuilder%3C'cb%3E">!RefUnwindSafe</a></li><li><a href="#impl-Send-for-CheckoutBuilder%3C'cb%3E">!Send</a></li><li><a href="#impl-Sync-for-CheckoutBuilder%3C'cb%3E">!Sync</a></li><li><a href="#impl-UnwindSafe-for-CheckoutBuilder%3C'cb%3E">!UnwindSafe</a></li><li><a href="#impl-Freeze-for-CheckoutBuilder%3C'cb%3E">Freeze</a></li><li><a href="#impl-Unpin-for-CheckoutBuilder%3C'cb%3E">Unpin</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block blanket-implementation"><li><a href="#impl-Any-for-T">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-T">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-T">BorrowMut<T></a></li><li><a href="#impl-From%3CT%3E-for-T">From<T></a></li><li><a href="#impl-Into%3CU%3E-for-T">Into<U></a></li><li><a href="#impl-TryFrom%3CU%3E-for-T">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E-for-T">TryInto<U></a></li></ul></section><h2><a href="index.html">In git2::build</a></h2></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1>Struct <a href="../index.html">git2</a>::<wbr><a href="index.html">build</a>::<wbr><a class="struct" href="#">CheckoutBuilder</a><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><span class="out-of-band"><a class="src" href="../../src/git2/build.rs.html#82-96">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub struct CheckoutBuilder<'cb> { <span class="comment">/* private fields */</span> }</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A builder struct for configuring checkouts of a repository.</p>
|
||
</div></details><h2 id="implementations" class="section-header">Implementations<a href="#implementations" class="anchor">§</a></h2><div id="implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-CheckoutBuilder%3C'cb%3E" class="impl"><a class="src rightside" href="../../src/git2/build.rs.html#326-618">source</a><a href="#impl-CheckoutBuilder%3C'cb%3E" class="anchor">§</a><h3 class="code-header">impl<'cb> <a class="struct" href="struct.CheckoutBuilder.html" title="struct git2::build::CheckoutBuilder">CheckoutBuilder</a><'cb></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.new" class="method"><a class="src rightside" href="../../src/git2/build.rs.html#329-346">source</a><h4 class="code-header">pub fn <a href="#method.new" class="fn">new</a>() -> <a class="struct" href="struct.CheckoutBuilder.html" title="struct git2::build::CheckoutBuilder">CheckoutBuilder</a><'cb></h4></section></summary><div class="docblock"><p>Creates a new builder for checkouts with all of its default
|
||
configuration.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.dry_run" class="method"><a class="src rightside" href="../../src/git2/build.rs.html#350-354">source</a><h4 class="code-header">pub fn <a href="#method.dry_run" class="fn">dry_run</a>(&mut self) -> &mut <a class="struct" href="struct.CheckoutBuilder.html" title="struct git2::build::CheckoutBuilder">CheckoutBuilder</a><'cb></h4></section></summary><div class="docblock"><p>Indicate that this checkout should perform a dry run by checking for
|
||
conflicts but not make any actual changes.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.force" class="method"><a class="src rightside" href="../../src/git2/build.rs.html#358-362">source</a><h4 class="code-header">pub fn <a href="#method.force" class="fn">force</a>(&mut self) -> &mut <a class="struct" href="struct.CheckoutBuilder.html" title="struct git2::build::CheckoutBuilder">CheckoutBuilder</a><'cb></h4></section></summary><div class="docblock"><p>Take any action necessary to get the working directory to match the
|
||
target including potentially discarding modified files.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.safe" class="method"><a class="src rightside" href="../../src/git2/build.rs.html#368-372">source</a><h4 class="code-header">pub fn <a href="#method.safe" class="fn">safe</a>(&mut self) -> &mut <a class="struct" href="struct.CheckoutBuilder.html" title="struct git2::build::CheckoutBuilder">CheckoutBuilder</a><'cb></h4></section></summary><div class="docblock"><p>Indicate that the checkout should be performed safely, allowing new
|
||
files to be created but not overwriting existing files or changes.</p>
|
||
<p>This is the default.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.recreate_missing" class="method"><a class="src rightside" href="../../src/git2/build.rs.html#386-388">source</a><h4 class="code-header">pub fn <a href="#method.recreate_missing" class="fn">recreate_missing</a>(&mut self, allow: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.bool.html">bool</a>) -> &mut <a class="struct" href="struct.CheckoutBuilder.html" title="struct git2::build::CheckoutBuilder">CheckoutBuilder</a><'cb></h4></section></summary><div class="docblock"><p>In safe mode, create files that don’t exist.</p>
|
||
<p>Defaults to false.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.allow_conflicts" class="method"><a class="src rightside" href="../../src/git2/build.rs.html#394-396">source</a><h4 class="code-header">pub fn <a href="#method.allow_conflicts" class="fn">allow_conflicts</a>(&mut self, allow: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.bool.html">bool</a>) -> &mut <a class="struct" href="struct.CheckoutBuilder.html" title="struct git2::build::CheckoutBuilder">CheckoutBuilder</a><'cb></h4></section></summary><div class="docblock"><p>In safe mode, apply safe file updates even when there are conflicts
|
||
instead of canceling the checkout.</p>
|
||
<p>Defaults to false.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.remove_untracked" class="method"><a class="src rightside" href="../../src/git2/build.rs.html#401-403">source</a><h4 class="code-header">pub fn <a href="#method.remove_untracked" class="fn">remove_untracked</a>(&mut self, remove: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.bool.html">bool</a>) -> &mut <a class="struct" href="struct.CheckoutBuilder.html" title="struct git2::build::CheckoutBuilder">CheckoutBuilder</a><'cb></h4></section></summary><div class="docblock"><p>Remove untracked files from the working dir.</p>
|
||
<p>Defaults to false.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.remove_ignored" class="method"><a class="src rightside" href="../../src/git2/build.rs.html#408-410">source</a><h4 class="code-header">pub fn <a href="#method.remove_ignored" class="fn">remove_ignored</a>(&mut self, remove: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.bool.html">bool</a>) -> &mut <a class="struct" href="struct.CheckoutBuilder.html" title="struct git2::build::CheckoutBuilder">CheckoutBuilder</a><'cb></h4></section></summary><div class="docblock"><p>Remove ignored files from the working dir.</p>
|
||
<p>Defaults to false.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.update_only" class="method"><a class="src rightside" href="../../src/git2/build.rs.html#417-419">source</a><h4 class="code-header">pub fn <a href="#method.update_only" class="fn">update_only</a>(&mut self, update: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.bool.html">bool</a>) -> &mut <a class="struct" href="struct.CheckoutBuilder.html" title="struct git2::build::CheckoutBuilder">CheckoutBuilder</a><'cb></h4></section></summary><div class="docblock"><p>Only update the contents of files that already exist.</p>
|
||
<p>If set, files will not be created or deleted.</p>
|
||
<p>Defaults to false.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.update_index" class="method"><a class="src rightside" href="../../src/git2/build.rs.html#425-427">source</a><h4 class="code-header">pub fn <a href="#method.update_index" class="fn">update_index</a>(&mut self, update: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.bool.html">bool</a>) -> &mut <a class="struct" href="struct.CheckoutBuilder.html" title="struct git2::build::CheckoutBuilder">CheckoutBuilder</a><'cb></h4></section></summary><div class="docblock"><p>Prevents checkout from writing the updated files’ information to the
|
||
index.</p>
|
||
<p>Defaults to true.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.refresh" class="method"><a class="src rightside" href="../../src/git2/build.rs.html#433-435">source</a><h4 class="code-header">pub fn <a href="#method.refresh" class="fn">refresh</a>(&mut self, refresh: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.bool.html">bool</a>) -> &mut <a class="struct" href="struct.CheckoutBuilder.html" title="struct git2::build::CheckoutBuilder">CheckoutBuilder</a><'cb></h4></section></summary><div class="docblock"><p>Indicate whether the index and git attributes should be refreshed from
|
||
disk before any operations.</p>
|
||
<p>Defaults to true,</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.skip_unmerged" class="method"><a class="src rightside" href="../../src/git2/build.rs.html#440-442">source</a><h4 class="code-header">pub fn <a href="#method.skip_unmerged" class="fn">skip_unmerged</a>(&mut self, skip: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.bool.html">bool</a>) -> &mut <a class="struct" href="struct.CheckoutBuilder.html" title="struct git2::build::CheckoutBuilder">CheckoutBuilder</a><'cb></h4></section></summary><div class="docblock"><p>Skip files with unmerged index entries.</p>
|
||
<p>Defaults to false.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.use_ours" class="method"><a class="src rightside" href="../../src/git2/build.rs.html#448-450">source</a><h4 class="code-header">pub fn <a href="#method.use_ours" class="fn">use_ours</a>(&mut self, ours: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.bool.html">bool</a>) -> &mut <a class="struct" href="struct.CheckoutBuilder.html" title="struct git2::build::CheckoutBuilder">CheckoutBuilder</a><'cb></h4></section></summary><div class="docblock"><p>Indicate whether the checkout should proceed on conflicts by using the
|
||
stage 2 version of the file (“ours”).</p>
|
||
<p>Defaults to false.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.use_theirs" class="method"><a class="src rightside" href="../../src/git2/build.rs.html#456-458">source</a><h4 class="code-header">pub fn <a href="#method.use_theirs" class="fn">use_theirs</a>(&mut self, theirs: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.bool.html">bool</a>) -> &mut <a class="struct" href="struct.CheckoutBuilder.html" title="struct git2::build::CheckoutBuilder">CheckoutBuilder</a><'cb></h4></section></summary><div class="docblock"><p>Indicate whether the checkout should proceed on conflicts by using the
|
||
stage 3 version of the file (“theirs”).</p>
|
||
<p>Defaults to false.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.overwrite_ignored" class="method"><a class="src rightside" href="../../src/git2/build.rs.html#463-465">source</a><h4 class="code-header">pub fn <a href="#method.overwrite_ignored" class="fn">overwrite_ignored</a>(
|
||
&mut self,
|
||
overwrite: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.bool.html">bool</a>,
|
||
) -> &mut <a class="struct" href="struct.CheckoutBuilder.html" title="struct git2::build::CheckoutBuilder">CheckoutBuilder</a><'cb></h4></section></summary><div class="docblock"><p>Indicate whether ignored files should be overwritten during the checkout.</p>
|
||
<p>Defaults to true.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.conflict_style_merge" class="method"><a class="src rightside" href="../../src/git2/build.rs.html#470-472">source</a><h4 class="code-header">pub fn <a href="#method.conflict_style_merge" class="fn">conflict_style_merge</a>(&mut self, on: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.bool.html">bool</a>) -> &mut <a class="struct" href="struct.CheckoutBuilder.html" title="struct git2::build::CheckoutBuilder">CheckoutBuilder</a><'cb></h4></section></summary><div class="docblock"><p>Indicate whether a normal merge file should be written for conflicts.</p>
|
||
<p>Defaults to false.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.notify_on" class="method"><a class="src rightside" href="../../src/git2/build.rs.html#478-484">source</a><h4 class="code-header">pub fn <a href="#method.notify_on" class="fn">notify_on</a>(
|
||
&mut self,
|
||
notification_types: <a class="struct" href="../struct.CheckoutNotificationType.html" title="struct git2::CheckoutNotificationType">CheckoutNotificationType</a>,
|
||
) -> &mut <a class="struct" href="struct.CheckoutBuilder.html" title="struct git2::build::CheckoutBuilder">CheckoutBuilder</a><'cb></h4></section></summary><div class="docblock"><p>Specify for which notification types to invoke the notification
|
||
callback.</p>
|
||
<p>Defaults to none.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.conflict_style_diff3" class="method"><a class="src rightside" href="../../src/git2/build.rs.html#490-492">source</a><h4 class="code-header">pub fn <a href="#method.conflict_style_diff3" class="fn">conflict_style_diff3</a>(&mut self, on: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.bool.html">bool</a>) -> &mut <a class="struct" href="struct.CheckoutBuilder.html" title="struct git2::build::CheckoutBuilder">CheckoutBuilder</a><'cb></h4></section></summary><div class="docblock"><p>Indicates whether to include common ancestor data in diff3 format files
|
||
for conflicts.</p>
|
||
<p>Defaults to false.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.disable_filters" class="method"><a class="src rightside" href="../../src/git2/build.rs.html#495-498">source</a><h4 class="code-header">pub fn <a href="#method.disable_filters" class="fn">disable_filters</a>(&mut self, disable: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.bool.html">bool</a>) -> &mut <a class="struct" href="struct.CheckoutBuilder.html" title="struct git2::build::CheckoutBuilder">CheckoutBuilder</a><'cb></h4></section></summary><div class="docblock"><p>Indicate whether to apply filters like CRLF conversion.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.dir_perm" class="method"><a class="src rightside" href="../../src/git2/build.rs.html#503-506">source</a><h4 class="code-header">pub fn <a href="#method.dir_perm" class="fn">dir_perm</a>(&mut self, perm: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.i32.html">i32</a>) -> &mut <a class="struct" href="struct.CheckoutBuilder.html" title="struct git2::build::CheckoutBuilder">CheckoutBuilder</a><'cb></h4></section></summary><div class="docblock"><p>Set the mode with which new directories are created.</p>
|
||
<p>Default is 0755</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.file_perm" class="method"><a class="src rightside" href="../../src/git2/build.rs.html#511-514">source</a><h4 class="code-header">pub fn <a href="#method.file_perm" class="fn">file_perm</a>(&mut self, perm: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.i32.html">i32</a>) -> &mut <a class="struct" href="struct.CheckoutBuilder.html" title="struct git2::build::CheckoutBuilder">CheckoutBuilder</a><'cb></h4></section></summary><div class="docblock"><p>Set the mode with which new files are created.</p>
|
||
<p>The default is 0644 or 0755 as dictated by the blob.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.path" class="method"><a class="src rightside" href="../../src/git2/build.rs.html#520-525">source</a><h4 class="code-header">pub fn <a href="#method.path" class="fn">path</a><T: <a class="trait" href="../trait.IntoCString.html" title="trait git2::IntoCString">IntoCString</a>>(&mut self, path: T) -> &mut <a class="struct" href="struct.CheckoutBuilder.html" title="struct git2::build::CheckoutBuilder">CheckoutBuilder</a><'cb></h4></section></summary><div class="docblock"><p>Add a path to be checked out.</p>
|
||
<p>If no paths are specified, then all files are checked out. Otherwise
|
||
only these specified paths are checked out.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.target_dir" class="method"><a class="src rightside" href="../../src/git2/build.rs.html#528-532">source</a><h4 class="code-header">pub fn <a href="#method.target_dir" class="fn">target_dir</a>(&mut self, dst: &<a class="struct" href="https://doc.rust-lang.org/1.80.0/std/path/struct.Path.html" title="struct std::path::Path">Path</a>) -> &mut <a class="struct" href="struct.CheckoutBuilder.html" title="struct git2::build::CheckoutBuilder">CheckoutBuilder</a><'cb></h4></section></summary><div class="docblock"><p>Set the directory to check out to</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.ancestor_label" class="method"><a class="src rightside" href="../../src/git2/build.rs.html#535-538">source</a><h4 class="code-header">pub fn <a href="#method.ancestor_label" class="fn">ancestor_label</a>(&mut self, label: &<a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.str.html">str</a>) -> &mut <a class="struct" href="struct.CheckoutBuilder.html" title="struct git2::build::CheckoutBuilder">CheckoutBuilder</a><'cb></h4></section></summary><div class="docblock"><p>The name of the common ancestor side of conflicts</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.our_label" class="method"><a class="src rightside" href="../../src/git2/build.rs.html#541-544">source</a><h4 class="code-header">pub fn <a href="#method.our_label" class="fn">our_label</a>(&mut self, label: &<a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.str.html">str</a>) -> &mut <a class="struct" href="struct.CheckoutBuilder.html" title="struct git2::build::CheckoutBuilder">CheckoutBuilder</a><'cb></h4></section></summary><div class="docblock"><p>The name of the common our side of conflicts</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.their_label" class="method"><a class="src rightside" href="../../src/git2/build.rs.html#547-550">source</a><h4 class="code-header">pub fn <a href="#method.their_label" class="fn">their_label</a>(&mut self, label: &<a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.str.html">str</a>) -> &mut <a class="struct" href="struct.CheckoutBuilder.html" title="struct git2::build::CheckoutBuilder">CheckoutBuilder</a><'cb></h4></section></summary><div class="docblock"><p>The name of the common their side of conflicts</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.progress" class="method"><a class="src rightside" href="../../src/git2/build.rs.html#553-559">source</a><h4 class="code-header">pub fn <a href="#method.progress" class="fn">progress</a><F>(&mut self, cb: F) -> &mut <a class="struct" href="struct.CheckoutBuilder.html" title="struct git2::build::CheckoutBuilder">CheckoutBuilder</a><'cb><div class="where">where
|
||
F: <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(<a class="enum" href="https://doc.rust-lang.org/1.80.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&<a class="struct" href="https://doc.rust-lang.org/1.80.0/std/path/struct.Path.html" title="struct std::path::Path">Path</a>>, <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.usize.html">usize</a>, <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.usize.html">usize</a>) + 'cb,</div></h4></section></summary><div class="docblock"><p>Set a callback to receive notifications of checkout progress.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.notify" class="method"><a class="src rightside" href="../../src/git2/build.rs.html#565-578">source</a><h4 class="code-header">pub fn <a href="#method.notify" class="fn">notify</a><F>(&mut self, cb: F) -> &mut <a class="struct" href="struct.CheckoutBuilder.html" title="struct git2::build::CheckoutBuilder">CheckoutBuilder</a><'cb><div class="where">where
|
||
F: <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(<a class="struct" href="../struct.CheckoutNotificationType.html" title="struct git2::CheckoutNotificationType">CheckoutNotificationType</a>, <a class="enum" href="https://doc.rust-lang.org/1.80.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&<a class="struct" href="https://doc.rust-lang.org/1.80.0/std/path/struct.Path.html" title="struct std::path::Path">Path</a>>, <a class="enum" href="https://doc.rust-lang.org/1.80.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="../struct.DiffFile.html" title="struct git2::DiffFile">DiffFile</a><'_>>, <a class="enum" href="https://doc.rust-lang.org/1.80.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="../struct.DiffFile.html" title="struct git2::DiffFile">DiffFile</a><'_>>, <a class="enum" href="https://doc.rust-lang.org/1.80.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="../struct.DiffFile.html" title="struct git2::DiffFile">DiffFile</a><'_>>) -> <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.bool.html">bool</a> + 'cb,</div></h4></section></summary><div class="docblock"><p>Set a callback to receive checkout notifications.</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><details class="toggle method-toggle" open><summary><section id="method.configure" class="method"><a class="src rightside" href="../../src/git2/build.rs.html#584-617">source</a><h4 class="code-header">pub unsafe fn <a href="#method.configure" class="fn">configure</a>(&mut self, opts: &mut <a class="struct" href="../../libgit2_sys/struct.git_checkout_options.html" title="struct libgit2_sys::git_checkout_options">git_checkout_options</a>)</h4></section></summary><div class="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
|
||
outlive the provided checkout options.</p>
|
||
</div></details></div></details></div><h2 id="trait-implementations" class="section-header">Trait Implementations<a href="#trait-implementations" class="anchor">§</a></h2><div id="trait-implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-Default-for-CheckoutBuilder%3C'cb%3E" class="impl"><a class="src rightside" href="../../src/git2/build.rs.html#320-324">source</a><a href="#impl-Default-for-CheckoutBuilder%3C'cb%3E" class="anchor">§</a><h3 class="code-header">impl<'cb> <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/default/trait.Default.html" title="trait core::default::Default">Default</a> for <a class="struct" href="struct.CheckoutBuilder.html" title="struct git2::build::CheckoutBuilder">CheckoutBuilder</a><'cb></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.default" class="method trait-impl"><a class="src rightside" href="../../src/git2/build.rs.html#321-323">source</a><a href="#method.default" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.80.0/core/default/trait.Default.html#tymethod.default" class="fn">default</a>() -> Self</h4></section></summary><div class='docblock'>Returns the “default value” for a type. <a href="https://doc.rust-lang.org/1.80.0/core/default/trait.Default.html#tymethod.default">Read more</a></div></details></div></details></div><h2 id="synthetic-implementations" class="section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor">§</a></h2><div id="synthetic-implementations-list"><section id="impl-Freeze-for-CheckoutBuilder%3C'cb%3E" class="impl"><a href="#impl-Freeze-for-CheckoutBuilder%3C'cb%3E" class="anchor">§</a><h3 class="code-header">impl<'cb> <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/marker/trait.Freeze.html" title="trait core::marker::Freeze">Freeze</a> for <a class="struct" href="struct.CheckoutBuilder.html" title="struct git2::build::CheckoutBuilder">CheckoutBuilder</a><'cb></h3></section><section id="impl-RefUnwindSafe-for-CheckoutBuilder%3C'cb%3E" class="impl"><a href="#impl-RefUnwindSafe-for-CheckoutBuilder%3C'cb%3E" class="anchor">§</a><h3 class="code-header">impl<'cb> !<a class="trait" href="https://doc.rust-lang.org/1.80.0/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="struct.CheckoutBuilder.html" title="struct git2::build::CheckoutBuilder">CheckoutBuilder</a><'cb></h3></section><section id="impl-Send-for-CheckoutBuilder%3C'cb%3E" class="impl"><a href="#impl-Send-for-CheckoutBuilder%3C'cb%3E" class="anchor">§</a><h3 class="code-header">impl<'cb> !<a class="trait" href="https://doc.rust-lang.org/1.80.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="struct.CheckoutBuilder.html" title="struct git2::build::CheckoutBuilder">CheckoutBuilder</a><'cb></h3></section><section id="impl-Sync-for-CheckoutBuilder%3C'cb%3E" class="impl"><a href="#impl-Sync-for-CheckoutBuilder%3C'cb%3E" class="anchor">§</a><h3 class="code-header">impl<'cb> !<a class="trait" href="https://doc.rust-lang.org/1.80.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="struct.CheckoutBuilder.html" title="struct git2::build::CheckoutBuilder">CheckoutBuilder</a><'cb></h3></section><section id="impl-Unpin-for-CheckoutBuilder%3C'cb%3E" class="impl"><a href="#impl-Unpin-for-CheckoutBuilder%3C'cb%3E" class="anchor">§</a><h3 class="code-header">impl<'cb> <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="struct.CheckoutBuilder.html" title="struct git2::build::CheckoutBuilder">CheckoutBuilder</a><'cb></h3></section><section id="impl-UnwindSafe-for-CheckoutBuilder%3C'cb%3E" class="impl"><a href="#impl-UnwindSafe-for-CheckoutBuilder%3C'cb%3E" class="anchor">§</a><h3 class="code-header">impl<'cb> !<a class="trait" href="https://doc.rust-lang.org/1.80.0/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a> for <a class="struct" href="struct.CheckoutBuilder.html" title="struct git2::build::CheckoutBuilder">CheckoutBuilder</a><'cb></h3></section></div><h2 id="blanket-implementations" class="section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor">§</a></h2><div id="blanket-implementations-list"><details class="toggle implementors-toggle"><summary><section id="impl-Any-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.80.0/src/core/any.rs.html#140">source</a><a href="#impl-Any-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T<div class="where">where
|
||
T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/1.80.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.80.0/src/core/any.rs.html#141">source</a><a href="#method.type_id" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.80.0/core/any/trait.Any.html#tymethod.type_id" class="fn">type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/1.80.0/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></h4></section></summary><div class='docblock'>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/1.80.0/core/any/trait.Any.html#tymethod.type_id">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.80.0/src/core/borrow.rs.html#208">source</a><a href="#impl-Borrow%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><T> for T<div class="where">where
|
||
T: ?<a class="trait" href="https://doc.rust-lang.org/1.80.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.80.0/src/core/borrow.rs.html#210">source</a><a href="#method.borrow" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.80.0/core/borrow/trait.Borrow.html#tymethod.borrow" class="fn">borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.reference.html">&T</a></h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.80.0/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.80.0/src/core/borrow.rs.html#216">source</a><a href="#impl-BorrowMut%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T<div class="where">where
|
||
T: ?<a class="trait" href="https://doc.rust-lang.org/1.80.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow_mut" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.80.0/src/core/borrow.rs.html#217">source</a><a href="#method.borrow_mut" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.80.0/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fn">borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.reference.html">&mut T</a></h4></section></summary><div class='docblock'>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.80.0/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.80.0/src/core/convert/mod.rs.html#765">source</a><a href="#impl-From%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for T</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.from" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.80.0/src/core/convert/mod.rs.html#768">source</a><a href="#method.from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.80.0/core/convert/trait.From.html#tymethod.from" class="fn">from</a>(t: T) -> T</h4></section></summary><div class="docblock"><p>Returns the argument unchanged.</p>
|
||
</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Into%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.80.0/src/core/convert/mod.rs.html#748-750">source</a><a href="#impl-Into%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><U> for T<div class="where">where
|
||
U: <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.80.0/src/core/convert/mod.rs.html#758">source</a><a href="#method.into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.80.0/core/convert/trait.Into.html#tymethod.into" class="fn">into</a>(self) -> U</h4></section></summary><div class="docblock"><p>Calls <code>U::from(self)</code>.</p>
|
||
<p>That is, this conversion is whatever the implementation of
|
||
<code><a href="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><details class="toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.80.0/src/core/convert/mod.rs.html#805-807">source</a><a href="#impl-TryFrom%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="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<div class="where">where
|
||
U: <a class="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><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl"><a href="#associatedtype.Error" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.80.0/core/convert/trait.TryFrom.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="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><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="toggle method-toggle" open><summary><section id="method.try_from" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.80.0/src/core/convert/mod.rs.html#812">source</a><a href="#method.try_from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.80.0/core/convert/trait.TryFrom.html#tymethod.try_from" class="fn">try_from</a>(value: U) -> <a class="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 <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="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><div class='docblock'>Performs the conversion.</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.80.0/src/core/convert/mod.rs.html#790-792">source</a><a href="#impl-TryInto%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="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<div class="where">where
|
||
U: <a class="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><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl"><a href="#associatedtype.Error-1" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.80.0/core/convert/trait.TryInto.html#associatedtype.Error" class="associatedtype">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="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><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="toggle method-toggle" open><summary><section id="method.try_into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.80.0/src/core/convert/mod.rs.html#797">source</a><a href="#method.try_into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.80.0/core/convert/trait.TryInto.html#tymethod.try_into" class="fn">try_into</a>(self) -> <a class="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 <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="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><div class='docblock'>Performs the conversion.</div></details></div></details></div></section></div></main></body></html> |