Struct GitPush 

#[non_exhaustive]
pub struct GitPush {
    pub remote: String,
    pub refspec: String,
    pub set_upstream: bool,
}

Options for GitApi::push (git push).

#[non_exhaustive], so build it through GitPush::branch / GitPush::refspec rather than a struct literal.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

remote: String

Remote to push to (defaults to origin).

refspec: String

The refspec — a bare branch name, or local:remote_branch.

set_upstream: bool

Set the pushed branch as the upstream (-u).

Implementations

impl GitPush

pub fn branch(name: impl Into<String>) -> Self

Push branch name to origin under the same name (git push origin <name>).

pub fn refspec(local: impl AsRef<str>, remote_branch: impl AsRef<str>) -> Self

Push local to a differently-named remote_branch (git push origin <local>:<remote_branch>).

pub fn remote(self, remote: impl Into<String>) -> Self

Push to a non-default remote.

pub fn set_upstream(self) -> Self

Record the pushed branch as the local branch’s upstream (-u).

Trait Implementations

impl Clone for GitPush

fn clone(&self) -> GitPush

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GitPush

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

Formats the value using the given formatter.