Skip to main content

PatchFlags

Struct PatchFlags 

Source
pub struct PatchFlags {
    pub status: Option<String>,
    pub priority: Option<String>,
    pub assignee: Option<String>,
    pub labels: Option<String>,
    pub start_date: Option<String>,
    pub due_date: Option<String>,
    pub estimate: Option<String>,
    pub cycles: Option<String>,
    pub milestones: Option<String>,
    pub clear: Vec<String>,
}
Expand description

The patch flags, exactly the confirmed typed fields.

A closed list, in the same sense IssuePatch is: there is no --set key=value, so there is no route by which --set number=99 or --set body=… reaches the code. contracts/cli-surface.md: “Patch flags are limited to the confirmed typed fields.”

Fields§

§status: Option<String>§priority: Option<String>§assignee: Option<String>§labels: Option<String>§start_date: Option<String>§due_date: Option<String>§estimate: Option<String>§cycles: Option<String>§milestones: Option<String>§clear: Vec<String>

--clear <field>, for the fields that support clearing.

Implementations§

Source§

impl PatchFlags

Source

pub fn clearable() -> &'static [&'static str]

The diagnostic listing every clearable field.

Source

pub fn field_rows() -> &'static [&'static str]

The flag rows, in the contract’s field order, plus clear.

The one list, so the TUI’s tab order, the CLI’s help and a test’s “every field is reachable” case cannot disagree. clear is last because it is the one row that is not a set — it empties a field, and a user tabbing through expects to set values first and clear one afterwards.

Source

pub fn is_clearable(field: &str) -> bool

Whether a field name can be cleared.

Source

pub fn is_empty(&self) -> bool

Whether any patch flag was given at all.

Source

pub fn to_patch(&self) -> Result<IssuePatch>

Build the typed patch.

A blank flag value is Unchanged, not Clear and not Set(""). A flag with no value is a flag the user did not mean, and treating it as “set it to the empty string” is the class of bug PatchValue exists to prevent — reached through the CLI this time rather than through the type.

Trait Implementations§

Source§

impl Clone for PatchFlags

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 Debug for PatchFlags

Source§

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

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

impl Default for PatchFlags

Source§

fn default() -> Self

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

impl Eq for PatchFlags

Source§

impl PartialEq for PatchFlags

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for PatchFlags

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<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
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.