Struct Proposal 

pub struct Proposal {
    pub identity: Identity,
    pub target_ref: String,
}

Everything one proposal is bound to, derived from the checkout.

Fields

identity: Identity

The change, workspace and idempotency key, derived together.

target_ref: String

Branch the proposal asks to land on, as a full refname.

Implementations

impl Proposal

pub fn derive(repo: &str, branch: &str, onto: &str) -> Result<Self, Failure>

Derives a proposal’s identifiers from the checkout’s branch and the branch it wants to land on.

Errors

Returns a Failure when the repository, branch or target is not a usable identifier.

pub fn revision_ref(&self, commit: &str) -> String

The refname one revision of this proposal is pushed to.

Named by the commit, under the proposal’s own namespace, and so append-only: re-proposing after an amend or a rebase adds a ref rather than moving one. Two properties follow, and both are why this is not simply a branch.

First, no force-push. A branch would refuse an amended commit as a non-fast-forward, and the repair for that is the force-push this project refuses everywhere else.

Second, and the reason worth the odd-looking refname: every revision the op log records stays fetchable. A checkpoint puts a revision hash in the log permanently; if the ref that made its objects reachable were overwritten, the log would go on naming a revision the repository could no longer produce. Gerrit keeps each patchset under refs/changes/NN/NNNN/P for the same reason.

The namespace is deliberately outside refs/heads/: these are object anchors, not branches, and a clone should not grow one local branch per revision of every open proposal. The current revision of a change is revision_id in the view, never the newest ref.

pub fn review_target(&self, repo: &str) -> String

The repo:ref spelling RequestReview records as the destination, which is what per-ref review policy reads.

Trait Implementations

impl Clone for Proposal

fn clone(&self) -> Proposal

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Proposal

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

Formats the value using the given formatter.

impl PartialEq for Proposal

fn eq(&self, other: &Proposal) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Proposal

impl StructuralPartialEq for Proposal