Skip to main content

ChangesetOperation

Struct ChangesetOperation 

Source
pub struct ChangesetOperation {
    pub id: String,
    pub label: String,
    pub description: Option<String>,
    pub scopes: Vec<ChangesetOperationScope>,
    pub confirmation: Option<StringOrMarkdown>,
    pub icon: Option<String>,
    pub group: Option<String>,
    pub status: ChangesetOperationStatus,
    pub error: Option<ErrorInfo>,
}
Expand description

A server-declared invokable verb the client can run against a changeset, a file, or a range — "stage", "revert", "create-pr", and so on.

The term “operation” is used deliberately to avoid colliding with the protocol-level Actions that mutate state.

Fields§

§id: String

Stable identifier, unique within this changeset.

§label: String

Human-readable button/menu label.

§description: Option<String>

Optional longer description shown on hover or in tooltips.

§scopes: Vec<ChangesetOperationScope>

Where this operation can be invoked.

§confirmation: Option<StringOrMarkdown>

Optional confirmation prompt to show before invoking. When present, the client MUST display this message to the user (typically in a confirmation dialog) and only invoke the operation after the user accepts. The presence of this field also signals that the operation is destructive — clients SHOULD style the affirmative button accordingly (e.g. with a warning colour).

§icon: Option<String>

Optional generic icon hint, e.g. "check", "trash".

§group: Option<String>

Optional group identifier, used to group related operations together.

§status: ChangesetOperationStatus

Current execution status. The server sets {@link ChangesetOperationStatus.Running | Running} while an invocation is in flight, {@link ChangesetOperationStatus.Error | Error} when the most recent invocation failed, and {@link ChangesetOperationStatus.Idle | Idle} otherwise.

Clients SHOULD reflect this state in the UI — e.g. disabling the control or showing a spinner while Running, and surfacing {@link error} while Error.

§error: Option<ErrorInfo>

Cause of failure. Present iff status === ChangesetOperationStatus.Error; otherwise omitted.

Trait Implementations§

Source§

impl Clone for ChangesetOperation

Source§

fn clone(&self) -> ChangesetOperation

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 ChangesetOperation

Source§

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

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

impl<'de> Deserialize<'de> for ChangesetOperation

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for ChangesetOperation

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl Serialize for ChangesetOperation

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for ChangesetOperation

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.