Skip to main content

Changeset

Struct Changeset 

Source
pub struct Changeset {
    pub label: String,
    pub uri_template: String,
    pub description: Option<String>,
    pub change_kind: String,
}
Expand description

Catalogue entry describing one changeset the server can produce for a session.

Catalogue entries are intentionally lightweight — just enough to render a chip or list row without subscribing. Full per-changeset detail ({@link ChangesetState}) lives on the subscribable URI obtained by expanding {@link uriTemplate}.

Fields§

§label: String

Human-readable label, e.g. "Uncommitted Changes".

§uri_template: String

RFC 6570 URI template. Clients parse the variables directly out of the template using the standard {name} syntax — they are not redeclared here.

Only the following template shapes are defined by this protocol; any other variable name MUST be ignored by clients (there is no protocol-defined way to obtain values for unknown variables):

Variables in templateMeaning
(none)A static, session-wide changeset. The template is itself a subscribable URI.
{turnId}Per-turn slice. Expand with a Turn.id from the session.
{originalTurnId} and {modifiedTurnId}Diff between two turns. Both variables MUST be present.

Future protocol versions MAY add new well-known variables.

§description: Option<String>

Optional longer description.

§change_kind: String

Advisory hint describing what kind of changeset this is, so clients can group, sort, or render an appropriate icon without parsing {@link uriTemplate}. Recognized values include:

  • 'session': a static, session-wide changeset covering all changes the agent has produced in this session.
  • 'branch': changes relative to a base branch (e.g. a feature branch diffed against main).
  • 'uncommitted': the workspace’s current uncommitted changes.
  • 'turn': changes produced by a single turn. Typically paired with a {turnId} variable in {@link uriTemplate}.
  • 'compare-turns': a diff between two turns. Typically paired with {originalTurnId} and {modifiedTurnId} variables in {@link uriTemplate}.

Implementations MAY provide additional values; clients SHOULD fall back to a reasonable default when an unknown value is encountered.

Trait Implementations§

Source§

impl Clone for Changeset

Source§

fn clone(&self) -> Changeset

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 Changeset

Source§

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

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

impl<'de> Deserialize<'de> for Changeset

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 Changeset

Source§

fn eq(&self, other: &Changeset) -> 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 Changeset

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 Changeset

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.