Skip to main content

PushOptions

Struct PushOptions 

Source
pub struct PushOptions {
    pub atomic: bool,
    pub dry_run: bool,
    pub tracking_remote: Option<String>,
    pub push_options: Vec<String>,
    pub diagnostics: Option<DiagnosticsHandle>,
    pub network_trace: bool,
    pub remote_ref_tips: Option<Vec<ObjectId>>,
}
Expand description

Options controlling a push.

Fields§

§atomic: bool

Apply all updates atomically (all-or-nothing).

§dry_run: bool

Compute results without writing to the remote.

§tracking_remote: Option<String>

When set, update refs/remotes/<name>/... in the local repo after a successful push (matching Git’s post-push tracking ref maintenance).

§push_options: Vec<String>

Server-side push options to transmit (git push --push-option <value>).

When non-empty, the negotiated capability list includes push-options and one push-option <value> pkt-line per entry is written after the ref-update command block and before the flush/pack. The remote exposes these to its hooks via GIT_PUSH_OPTION_COUNT / GIT_PUSH_OPTION_<n>.

If this is non-empty but the remote git-receive-pack does not advertise the push-options capability, the push fails with crate::error::Error::PushOptionsUnsupported (matching Git).

§diagnostics: Option<DiagnosticsHandle>

Diagnostic sink for crate::diagnostics::Trace::Network events.

§network_trace: bool

When true with Self::diagnostics, push paths may emit network trace events.

§remote_ref_tips: Option<Vec<ObjectId>>

Ref tips already read from the remote, for example while planning (PushPlanContext::remote_tips).

A local push uses them as the objects the remote already has instead of listing the remote’s refs again; ref updates still check each destination’s current value. They must come from the push destination, or objects the destination lacks may be left out of the pack. Wire pushes read the advertisement from their connection and ignore this.

Trait Implementations§

Source§

impl Clone for PushOptions

Source§

fn clone(&self) -> Self

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 Default for PushOptions

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 = !

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

fn try_from(value: U) -> Result<T, !>

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.