Skip to main content

AnnotationsUpdatedAction

Struct AnnotationsUpdatedAction 

Source
pub struct AnnotationsUpdatedAction {
    pub annotation_id: String,
    pub turn_id: Option<String>,
    pub resource: Option<Uri>,
    pub range: Option<TextRange>,
    pub resolved: Option<bool>,
}
Expand description

Partially update an existing {@link Annotation}’s own properties — a narrow alternative to {@link AnnotationsSetAction} for the common case of resolving / re-opening or re-anchoring an annotation without resending its {@link Annotation.entries | entries}.

Targets one annotation by its {@link annotationId}. Only the fields present on the action are written; omitted fields leave the corresponding {@link Annotation} property unchanged. The annotation’s {@link Annotation.entries | entries}, {@link Annotation.id | id}, and {@link Annotation._meta | _meta} are never touched — dispatch {@link AnnotationsSetAction} to replace those, to clear {@link range} (re-anchor to the whole file), or {@link AnnotationsEntrySetAction} / {@link AnnotationsEntryRemovedAction} to edit individual entries.

If {@link annotationId} does not match any current annotation the action is a no-op.

Fields§

§annotation_id: String

The {@link Annotation.id} of the annotation to update.

§turn_id: Option<String>

Re-anchors the annotation to the file versions this turn produced. Matches a {@link Turn.id} on the owning session. Omit to leave the current {@link Annotation.turnId} unchanged.

§resource: Option<Uri>

Re-anchors the annotation to this file. Omit to leave the current {@link Annotation.resource} unchanged.

§range: Option<TextRange>

Narrows the annotation to this range within {@link resource}. Omit to leave the current {@link Annotation.range} unchanged; this action cannot clear an existing range — dispatch {@link AnnotationsSetAction} to re-anchor to the whole file.

§resolved: Option<bool>

Marks the annotation resolved (true) or re-opens it (false). Omit to leave the current {@link Annotation.resolved} state unchanged.

Trait Implementations§

Source§

impl Clone for AnnotationsUpdatedAction

Source§

fn clone(&self) -> AnnotationsUpdatedAction

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 AnnotationsUpdatedAction

Source§

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

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

impl<'de> Deserialize<'de> for AnnotationsUpdatedAction

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 AnnotationsUpdatedAction

Source§

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

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 AnnotationsUpdatedAction

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.