Skip to main content

FetchOptions

Struct FetchOptions 

Source
pub struct FetchOptions {
    pub refspecs: Vec<String>,
    pub negative_refspecs: Vec<String>,
    pub tags: TagMode,
    pub prune: bool,
    pub dry_run: bool,
    pub depth: Option<u32>,
    pub deepen_since: Option<String>,
    pub deepen_not: Vec<String>,
    pub unshallow: bool,
}
Expand description

Options controlling a fetch.

Fields§

§refspecs: Vec<String>

Positive refspecs selecting what to fetch.

§negative_refspecs: Vec<String>

Negative refspecs excluding refs from the positive set.

§tags: TagMode

Tag-following policy.

§prune: bool

Whether to prune local tracking refs that vanished on the remote.

§dry_run: bool

Compute and report updates without writing any refs or objects.

§depth: Option<u32>

Truncate history to the given number of commits per tip (git fetch --depth N). Drives the wire deepen N / v2 deepen arg and, for a previously shallow repo, deepens the existing boundary. None requests full history.

§deepen_since: Option<String>

Deepen history to include commits no older than this cutoff (git fetch --shallow-since <date>). The value is sent verbatim as the wire deepen-since <value>; callers should pass the Unix timestamp Git’s upload-pack expects (a bare integer), not a human date string.

§deepen_not: Vec<String>

Deepen history but stop at (exclude) commits reachable from these refs/oids (git fetch --shallow-exclude <ref>). Each entry is sent as a wire deepen-not <ref>.

§unshallow: bool

Convert a shallow repository back into a complete one (git fetch --unshallow). Drives the wire deepen 0x7fffffff request and removes the local shallow boundaries that get reported as unshallow.

Implementations§

Source§

impl FetchOptions

Source

pub fn has_deepen_request(&self) -> bool

Whether this fetch carries any shallow/deepen request (an explicit depth/deepen-since/deepen-not/unshallow). Note this does NOT cover the “already shallow, fetching more of the same boundary” case — that is driven by the on-disk shallow file, checked separately by the fetch paths via crate::shallow::load_shallow_oids.

Trait Implementations§

Source§

impl Clone for FetchOptions

Source§

fn clone(&self) -> FetchOptions

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for FetchOptions

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for FetchOptions

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.