Struct ChangeSpec 

pub struct ChangeSpec {
    pub head: String,
    pub base: String,
    pub title: String,
    pub body: Option<String>,
    pub draft: Option<DraftReason>,
    pub draft_awaiting_checks: bool,
}

What to open a change request for.

Fields

head: String

The branch carrying the change.

base: String

The branch it targets, which for a stacked change is the branch below it.

title: String

The title, which under squash-merge becomes the commit subject.

body: Option<String>

The body. Absent means the host’s default from the repository template.

draft: Option<DraftReason>

Open it as a draft, and why it is not ready. Absent opens an ordinary change request, which is every publication that came before this field.

The host is handed the whole reason and asked for one thing with it: open the change as a draft. Nothing here renders the reason into the change request — see DraftReason for the ruling that keeps it out of the body — so a host implementation that reads past this field’s presence is reading further than the contract asks it to.

draft_awaiting_checks: bool

Open it as a draft while its required checks run, with no DraftReason: what a lifecycle publication asks for when its caller asked for no draft. A host lifts or keeps it once the checks settle, by the rules the publication states; nothing here is a reason a caller gave.

Beside draft rather than a third kind of it, because DraftReason is what a caller asks for and this is what the lifecycle asks for when the caller asked for none. Defaulted and omitted when false, so a spec written before it reads and writes as it did. Where both are set the reason is what the host records: either way the change opens as a draft.

Trait Implementations

impl Clone for ChangeSpec

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ChangeSpec

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ChangeSpec

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ChangeSpec

impl PartialEq for ChangeSpec

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ChangeSpec

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ChangeSpec